Immunization

Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.

http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-immunization.html

Endpoints

get
/Immunization/{id}
 get
/Immunization

Attributes

id
string

The Canvas identifier of the immunization

status
string

The status of the immunization

One of: completed, not-done, entered-in-error

statusReason
json

A coding for reason not given, if recorded - ommitted otherwise.

vaccineCode
json

Coding for the administered vaccine

patient
json

The patient who received the immunization

occurrenceDateTime
date

The date or datetime the immunization was administered or reported to have been administered

primarySource
boolean

Whether the immunization was administered by a primary source

true indicates that the immunization was administered within the clinic. To document immunizations like these, check out this Zendesk article.

false indicates that the immunization was administered outside the clinic. To document this immunizations like these, check out this Zendesk article.

get
/Immunization/{id}

Immunization read

Path Parameters

id required
string
The unique identifier for the Immunization

Responses

200 OK
Request was successful.

Errors

401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
404 Not Found
The requested resource was not found.
get
/Immunization

Immunization search

Query Parameters

_id
string

A Canvas-issued unique identifier

patient
string

The patient for the vaccination record

Responses

200 OK
Request was successful.

Errors

400 Bad Request
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/Immunization/<id>' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/Immunization/<id>"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

  • {
  "resourceType": "Immunization",
  "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a",
  "status": "completed",
  "vaccineCode": {
      "coding": [
        {
          "system": "http://hl7.org/fhir/sid/cvx",
          "code": "207",
          "display": "Moderna Severe acute respiratory syndrome coronavirus 2 (SARS-CoV-2) (coronavirus disease [COVID-19]) vaccine, mRNA-LNP, spike protein, preservative free, 50 mcg/0.25 mL dosage, for intramuscular use"
        }
      ]
  },
  "patient": {
      "reference": "Patient/a1197fa9e65b4a5195af15e0234f61c2",
      "type": "Patient"
  },
  "occurrenceDateTime": "2022-05-26T18:55:34.629659+00:00",
  "primarySource": false
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "unknown",
      "details": {
        "text": "Authentication failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "forbidden",
      "details": {
        "text": "Authorization failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "not-found",
      "details": {
        "text": "Unknown Immunization resource 'd9aefede-da05-4bef-bbf9-63bcf83c806b'"
      }
    }
  ]
}

  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/Immunization?patient=Patient/4d9c4a797b8c4a58872017e7a19a474e' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/Immunization?patient=Patient/4d9c4a797b8c4a58872017e7a19a474e"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

  • {
    "resourceType": "Bundle",
    "type": "searchset",
    "total": 1,
    "link": [
      {
        "relation": "self",
        "url": "/Immunization?patient=Patient%2F4d9c4a797b8c4a58872017e7a19a474e&_count=10&_offset=0"
      },
      {
        "relation": "first",
        "url": "/Immunization?patient=Patient%2F4d9c4a797b8c4a58872017e7a19a474e&_count=10&_offset=0"
      },
      {
        "relation": "last",
        "url": "/Immunization?patient=Patient%2F4d9c4a797b8c4a58872017e7a19a474e&_count=10&_offset=0"
      }
    ],
    "entry": [
      {
        "resource": {
          "resourceType": "Immunization",
          "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a",
          "status": "completed",
          "vaccineCode": {
            "coding": [
              {
                "system": "http://hl7.org/fhir/sid/cvx",
                "code": "207",
                "display": "Moderna Severe acute respiratory syndrome coronavirus 2 (SARS-CoV-2) (coronavirus disease [COVID-19]) vaccine, mRNA-LNP, spike protein, preservative free, 50 mcg/0.25 mL dosage, for intramuscular use"
              }
            ]
          },
          "patient": {
              "reference": "Patient/4d9c4a797b8c4a58872017e7a19a474e",
              "type": "Patient"
          },
          "occurrenceDateTime": "2021-12-01",
          "primarySource": false
        }
      }
    ]
}