Sign in

v1

latestOpenAPI 3.0.32026-07-247462851.8 MB
EnrollmentStatuses

Create a new enrollment

Enroll a patient in a package.

post/enrollment-statuses

Request body

Example request

{
  "data": {
    "type": "zap-data-subscriptions/enrollment-status",
    "attributes": {
      "provider": {
        "resourceId": "b780be5f-d927-45b8-8aff-2eb0c7769041",
        "npi": "1657598797",
        "firstName": "Jason",
        "lastName": "Smith",
        "name": "Jason Smith",
        "role": "309343006"
      },
      "practitioner": {
        "resourceId": "b780be5f-d927-45b8-8aff-2eb0c7769041",
        "npi": "1657598797",
        "firstName": "Jason",
        "lastName": "Smith",
        "name": "Jason Smith",
        "role": "309343006"
      },
      "patient": {
        "resourceType": "Patient",
        "identifier": [
          {
            "system": "https://www.samplehealth.com/MRN",
            "value": "5678943210"
          }
        ],
        "name": [
          {
            "family": "Smith",
            "given": [
              {
                "given_1": "John",
                "given_2": "J"
              }
            ]
          }
        ],
        "gender": "male",
        "birthDate": "1977-01-16",
        "address": [
          {
            "line": [
              {
                "line_1": "123 Elm St.",
                "line_2": "Apt. 23"
              }
            ],
            "city": "Cleveland",
            "state": "OH",
            "postalCode": "44109"
          }
        ],
        "telecom": [
          {
            "system": "home",
            "use": "phone",
            "value": "12124567890"
          }
        ]
      }
    },
    "relationships": {
      "patient": {
        "data": {
          "type": "fhir/Patient",
          "id": "cda44e3b-99f1-4477-9e70-f36c8fa5000c"
        }
      },
      "practitioner": {
        "data": {
          "type": "fhir/Practitioner",
          "id": "4e6e0ac0-1f37-481a-a711-a15f990a4f0e"
        }
      },
      "organization": {
        "data": {
          "type": "fhir/Organization",
          "id": "7a98d998-840e-4e18-bf3f-a00ef1b54df6"
        }
      },
      "package": {
        "data": {
          "type": "zap-data-subscriptions/package",
          "id": "f5be3aec-ef48-4f21-b399-5594ec30f294"
        }
      }
    }
  }
}

Response

Successfully created the package enrollment status. The patient is now enrolled in the package.

Example response

{
  "data": {
    "type": "zap-data-subscriptions/enrollment-status",
    "id": "6aaf0003-a684-440e-9251-05bf8dad481d",
    "attributes": {
      "provider": {
        "resourceId": "b780be5f-d927-45b8-8aff-2eb0c7769041",
        "npi": "1657598797",
        "firstName": "Jason",
        "lastName": "Smith",
        "name": "Jason Smith",
        "role": "309343006"
      },
      "practitioner": {
        "resourceId": "b780be5f-d927-45b8-8aff-2eb0c7769041",
        "npi": "1657598797",
        "firstName": "Jason",
        "lastName": "Smith",
        "name": "Jason Smith",
        "role": "309343006"
      },
      "createdAt": "2023-01-06T13:49:02+0000"
    },
    "relationships": {
      "patient": {
        "data": {
          "type": "fhir/Patient",
          "id": "cda44e3b-99f1-4477-9e70-f36c8fa5000c"
        }
      },
      "package": {
        "data": {
          "type": "zap-data-subscriptions/package",
          "id": "f5be3aec-ef48-4f21-b399-5594ec30f294"
        }
      },
      "createdBy": {
        "data": {
          "type": "auth/user",
          "id": "d4c3dc2e-9b69-4470-b2a4-c8e56360ce26",
          "meta": {
            "userEmail": "joanne@example.com"
          }
        }
      }
    }
  }
}