PAparticlehealth
Subscriptions

Create Patient Subscriptions

Changed on
post/api/v1/patients/{particle_patient_id}/subscriptions

Request

  • Base URL
    https://sandbox.particlehealth.com
  • URL
    https://sandbox.particlehealth.com/api/v1/patients/{particle_patient_id}/subscriptions
  • Auth
    API key in header Authorization

Path parameters

particle_patient_idstring required

Particle Patient ID

Request body

Example request

{
  "subscriptions": [
    {
      "monitoring_plan": "ACTIVE",
      "particle_patient_id": "123456",
      "referred_to_oid": "2.16.840.1.113883.3.8391",
      "type": "MONITORING"
    }
  ]
}

Response

OK

Example response

{
  "subscriptions": [
    {
      "particle_patient_id": "123456",
      "type": "ADT"
    }
  ]
}

Changes

  • b59a5413a488Revision changes
    • breaking

      the request property became required

    • breaking

      the request property // became required

    • breaking

      the request property's minItems was increased to 1

    • info

      added the new optional request property //

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status