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
In Canvas, Immunization records are recorded using either the Immunization Statement Commmand or the Immunize Command.
Immunization create
Immunization records created through this endpoint will be stored in an Immunization Statement command on the patient’s chart. There currently is no support to create an Immunize command with this endpoint.
Attributes
The FHIR Resource name.
Canvas supports a note identifier extension on this resource. The note identifier can be used with the Canvas Note API.
Canvas recommends sending the note identifier extension or the Encounter reference, but not both. If both are supplied, they must both refer to the same note. If neither is specified, it will insert into a Data Import note where the DOS is the current time of ingestion.
Identifies the meaning of the extension
The valueId field is used for the Note extension and will be the note’s unique identifier.
The status of the immunization.
Coding for the administered vaccine.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
The patient who received the immunization.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
Supply an encounter reference to be able to insert the command into a specific note on the patient’s timeline. If no encounter is specified, it will insert into a Data Import note where the DOS is the current time of ingestion.
Canvas does not currently support concurrent creation of resources on the same encounter. Please avoid issuing concurrent requests that reference the same encounter to this endpoint, or to any other endpoints that reference encounters. It is OK to issue concurrent requests to these endpoints as long as the requests reference different encounters.
The reference string of the encounter in the format of "Encounter/76028e14e77a47f4b95149bf5b7400bb".
Type the reference refers to (e.g. “Encounter”).
The date or datetime the immunization was administered or reported to have been administered.
Whether the immunization was administered by a primary source.
On create accepts only false.
Additional text not captured in other fields.
Canvas will display this in the comment field of the immunization statement command. If there are multiple objects given, they will be separeted by a new line on the UI.
The annotation - text content.
Responses
Canvas returns the created resource's id as a UUID within the
location header and a null response body.Errors
Immunization read
Path Parameters
Response Payload Attributes
The FHIR Resource name.
The Canvas identifier of the immunization.
Canvas supports a note identifier extension on this resource. The note identifier can be used with the Canvas Note API.
Identifies the meaning of the extension
The valueId field is used for the Note extension and will be the note’s unique identifier.
The status of the immunization.
A coding for reason not given, if recorded - omitted otherwise.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
Coding for the administered vaccine.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
The patient who received the immunization.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
The encounter related to the provided Note in the extension of this resource.
The reference string of the encounter in the format of "Encounter/76028e14e77a47f4b95149bf5b7400bb".
Type the reference refers to (e.g. “Encounter”).
The date or datetime the immunization was administered or reported to have been administered.
Whether the immunization was administered by a primary source.
- true indicates that the immunization was administered within the clinic. To document immunizations like these, use an Immunize Command.
- false indicates that the immunization was administered outside the clinic. To document this immunizations like these, use an Immunization Statement Command.
Additional text not captured in other fields.
Canvas will display this in the comment field of the immunization statement command. If there are multiple objects given, they will be separeted by a new line on the UI.
The annotation - text content.
Responses
Errors
Immunization update
Update an Immunization resource.
The only type of Immunization update interaction that is supported by Canvas is to mark an existing Immunization Statement as entered-in-error using the status attribute. No changes to other fields will be processed; however, required fields still need to be supplied.
Attributes
The FHIR Resource name.
The Canvas identifier of the immunization.
Canvas supports a note identifier extension on this resource. The note identifier can be used with the Canvas Note API.
Identifies the meaning of the extension
The valueId field is used for the Note extension and will be the note’s unique identifier.
The status of the immunization.
Coding for the administered vaccine.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
The patient who received the immunization.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
The encounter related to the provided Note in the extension of this resource.
The reference string of the encounter in the format of "Encounter/76028e14e77a47f4b95149bf5b7400bb".
Type the reference refers to (e.g. “Encounter”).
The date or datetime the immunization was administered or reported to have been administered.
Whether the immunization was administered by a primary source.
Additional text not captured in other fields.
Canvas will display this in the comment field of the immunization statement command. If there are multiple objects given, they will be separeted by a new line on the UI.
The annotation - text content.
Responses
Errors
Immunization search
Query Parameters
A Canvas-issued unique identifier for a specific immunization.
The patient for the vaccination record in the format Patient/a39cafb9d1b445be95a2e2548e12a787.
Response Payload Attributes
The FHIR Resource name.
This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .
The number of resources that match the search parameter.
Attributes relevant to pagination, see our Pagination page for more detail.
The relation of the page search
The search url for the specific relation
The results bundle that lists out each object returned in the search
The attributes specific to the resource type, see the Attributes section below
Attributes
The FHIR Resource name.
The Canvas identifier of the immunization.
Canvas supports a note identifier extension on this resource. The note identifier can be used with the Canvas Note API.
Identifies the meaning of the extension
The valueId field is used for the Note extension and will be the note’s unique identifier.
The status of the immunization.
A coding for reason not given, if recorded - omitted otherwise.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
Coding for the administered vaccine.
Code defined by a terminology system.
The system url of the coding.
The code.
The display name of the coding.
The patient who received the immunization.
The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".
Type the reference refers to (e.g. “Patient”).
The encounter related to the provided Note in the extension of this resource.
The reference string of the encounter in the format of "Encounter/76028e14e77a47f4b95149bf5b7400bb".
Type the reference refers to (e.g. “Encounter”).
The date or datetime the immunization was administered or reported to have been administered.
Whether the immunization was administered by a primary source.
- true indicates that the immunization was administered within the clinic. To document immunizations like these, use an Immunize Command.
- false indicates that the immunization was administered outside the clinic. To document this immunizations like these, use an Immunization Statement Command.
Additional text not captured in other fields.
Canvas will display this in the comment field of the immunization statement command. If there are multiple objects given, they will be separeted by a new line on the UI.
The annotation - text content.
Responses
Errors
curl --request POST \ --url 'https://fumage-example.canvasmedical.com/Immunization' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data ' { "resourceType": "Immunization", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "eb754467-c8fc-4eac-9f36-2f46a510b48f" } ], "status": "completed", "vaccineCode": { "coding": [ { "system": "http://hl7.org/fhir/sid/cvx", "code": "110" }, { "system": "http://www.ama-assn.org/go/cpt", "code": "90723" } ] }, "patient": { "reference": "Patient/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Patient" }, "encounter": { "reference": "Encounter/76028e14-e77a-47f4-b951-49bf5b7400bb" }, "occurrenceDateTime": "2024-10-04", "primarySource": false, "note": [ { "text": "First Dose" } ] }'import requests url = "https://fumage-example.canvasmedical.com/Immunization" headers = { "accept": "application/json", "Authorization": "Bearer <token>", "content-type": "application/json", } payload = { "resourceType": "Immunization", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "eb754467-c8fc-4eac-9f36-2f46a510b48f" } ], "status": "completed", "vaccineCode": { "coding": [ { "system": "http://hl7.org/fhir/sid/cvx", "code": "110" }, { "system": "http://www.ama-assn.org/go/cpt", "code": "90723" } ] }, "patient": { "reference": "Patient/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Patient" }, "encounter": { "reference": "Encounter/76028e14-e77a-47f4-b951-49bf5b7400bb" }, "occurrenceDateTime": "2024-10-04", "primarySource": False, "note": [ { "text": "First Dose" } ] }
null{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "text": "Bad request" } } ] }{ "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-supported", "details": { "text": "Operation is not supported" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "text": "Unprocessable entity" } } ] }
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", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "eb754467-c8fc-4eac-9f36-2f46a510b48f" } ], "status": "completed", "vaccineCode": { "coding": [ { "system": "http://hl7.org/fhir/sid/cpt", "code": "91306", "display": "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" }, { "system": "http://hl7.org/fhir/sid/cvx", "code": "207", "display": "COVID-19, mRNA, LNP-S, PF, 100 mcg/0.5mL dose or 50 mcg/0.25mL dose" } ] }, "patient": { "reference": "Patient/a1197fa9e65b4a5195af15e0234f61c2", "type": "Patient" }, "encounter": { "reference": "Encounter/76028e14-e77a-47f4-b951-49bf5b7400bb" }, "occurrenceDateTime": "2022-05-26T18:55:34.629659+00:00", "primarySource": false, "note": [ { "text": "First Dose" } ] }{ "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 POST \ --url 'https://fumage-example.canvasmedical.com/Immunization/d9aefede-da05-4bef-bbf9-63bcf83c806a' \ --header 'Authorization: Bearer <token>' \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --data ' { "resourceType": "Immunization", "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "eb754467-c8fc-4eac-9f36-2f46a510b48f" } ], "status": "entered-in-error", "vaccineCode": { "coding": [ { "system": "http://hl7.org/fhir/sid/cpt", "code": "91306", "display": "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" }, { "system": "http://hl7.org/fhir/sid/cvx", "code": "207", "display": "COVID-19, mRNA, LNP-S, PF, 100 mcg/0.5mL dose or 50 mcg/0.25mL dose" } ] }, "patient": { "reference": "Patient/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Patient" }, "encounter": { "reference": "Encounter/76028e14-e77a-47f4-b951-49bf5b7400bb" }, "occurrenceDateTime": "2024-10-04", "primarySource": False, "note": [ { "text": "First Dose" } ] }'import requests url = "https://fumage-example.canvasmedical.com/Immunization/d9aefede-da05-4bef-bbf9-63bcf83c806a" headers = { "accept": "application/json", "Authorization": "Bearer <token>", "content-type": "application/json", } payload = { "resourceType": "Immunization", "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "eb754467-c8fc-4eac-9f36-2f46a510b48f" } ], "status": "entered-in-error", "vaccineCode": { "coding": [ { "system": "http://hl7.org/fhir/sid/cpt", "code": "91306", "display": "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" }, { "system": "http://hl7.org/fhir/sid/cvx", "code": "207", "display": "COVID-19, mRNA, LNP-S, PF, 100 mcg/0.5mL dose or 50 mcg/0.25mL dose" } ] }, "patient": { "reference": "Patient/4d789a3d5e794c0eb159a126b48c8b9f", "type": "Patient" }, "encounter": { "reference": "Encounter/76028e14-e77a-47f4-b951-49bf5b7400bb" }, "occurrenceDateTime": "2024-10-04", "primarySource": False, "note": [ { "text": "First Dose" } ] }
null{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "invalid", "details": { "text": "Bad request" } } ] }{ "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-supported", "details": { "text": "Operation is not supported" } } ] }{ "resourceType": "OperationOutcome", "issue": [ { "severity": "error", "code": "business-rule", "details": { "text": "Unprocessable entity" } } ] }
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", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "eb754467-c8fc-4eac-9f36-2f46a510b48f" } ], "status": "completed", "vaccineCode": { "coding": [ { "system": "http://hl7.org/fhir/sid/cpt", "code": "91306", "display": "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" }, { "system": "http://hl7.org/fhir/sid/cvx", "code": "207", "display": "COVID-19, mRNA, LNP-S, PF, 100 mcg/0.5mL dose or 50 mcg/0.25mL dose" } ] }, "patient": { "reference": "Patient/4d9c4a797b8c4a58872017e7a19a474e", "type": "Patient" }, "encounter": { "reference": "Encounter/76028e14-e77a-47f4-b951-49bf5b7400bb" }, "occurrenceDateTime": "2021-12-01", "primarySource": false } }, { "resource": { "resourceType": "Immunization", "id": "d9aefede-da05-4bef-bbf9-63bcf83c806a", "extension": [ { "url": "http://schemas.canvasmedical.com/fhir/extensions/note-id", "valueId": "eb754467-c8fc-4eac-9f36-2f46a510b48f" } ], "status": "completed", "vaccineCode": { "coding": [ { "system": "http://www.ama-assn.org/go/cpt", "code": "90715", "display": "TDAP VACCINE 7 YRS/> IM" }, { "system": "http://hl7.org/fhir/sid/cvx", "code": "115", "display": "Tdap" } ] }, "patient": { "reference": "Patient/4d9c4a797b8c4a58872017e7a19a474e", "type": "Patient" }, "encounter": { "reference": "Encounter/76028e14-e77a-47f4-b951-49bf5b7400bb" }, "occurrenceDateTime": "2021-12-01", "primarySource": false, "note": [ { "text": "First Dose" } ] } } ] }