immunizations

Create Immunization

post
/organizations/{organizationId}/fhir/3/Immunization

Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringImmunizationThis is a Immunization resource
identifierarray(Identifier)A unique identifier assigned to this immunization record.
statusstringIndicates the current status of the vaccination event.
notGivenbooleanIndicates if the vaccination was or was not given.
vaccineCode*CodeableConceptVaccine that was administered or was to be administered.
patient*ReferenceThe patient who either received or did not receive the immunization.
encounterReferenceThe visit or admission or other contact between patient and health care provider the immunization was performed as part of.
datestringDate vaccine administered or was to be administered.
primarySourcebooleanAn indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
reportOriginCodeableConceptThe source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
locationReferenceThe service delivery location where the vaccine administration occurred.
manufacturerReferenceName of vaccine manufacturer.
lotNumberstringLot number of the vaccine product.
expirationDatestringDate vaccine batch expires.
siteCodeableConceptBody site where vaccine was administered.
routeCodeableConceptThe path by which the vaccine product is taken into the body.
doseQuantityQuantityThe quantity of vaccine product that was administered.
practitionerarray(Immunization_Practitioner)Indicates who or what performed the event.
notearray(Annotation)Extra information about the immunization that is not conveyed by the other attributes.
explanationImmunization_ExplanationReasons why a vaccine was or was not administered.
reactionarray(Immunization_Reaction)Categorical data indicating that an adverse event is associated in time to an immunization.
vaccinationProtocolarray(Immunization_VaccinationProtocol)Contains information about the protocol(s) under which the vaccine was administered.

Response

Patch Immunization

patch
/organizations/{organizationId}/fhir/3/Immunization/{resourceId}

Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringImmunizationThis is a Immunization resource
identifierarray(Identifier)A unique identifier assigned to this immunization record.
statusstringIndicates the current status of the vaccination event.
notGivenbooleanIndicates if the vaccination was or was not given.
vaccineCode*CodeableConceptVaccine that was administered or was to be administered.
patient*ReferenceThe patient who either received or did not receive the immunization.
encounterReferenceThe visit or admission or other contact between patient and health care provider the immunization was performed as part of.
datestringDate vaccine administered or was to be administered.
primarySourcebooleanAn indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
reportOriginCodeableConceptThe source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
locationReferenceThe service delivery location where the vaccine administration occurred.
manufacturerReferenceName of vaccine manufacturer.
lotNumberstringLot number of the vaccine product.
expirationDatestringDate vaccine batch expires.
siteCodeableConceptBody site where vaccine was administered.
routeCodeableConceptThe path by which the vaccine product is taken into the body.
doseQuantityQuantityThe quantity of vaccine product that was administered.
practitionerarray(Immunization_Practitioner)Indicates who or what performed the event.
notearray(Annotation)Extra information about the immunization that is not conveyed by the other attributes.
explanationImmunization_ExplanationReasons why a vaccine was or was not administered.
reactionarray(Immunization_Reaction)Categorical data indicating that an adverse event is associated in time to an immunization.
vaccinationProtocolarray(Immunization_VaccinationProtocol)Contains information about the protocol(s) under which the vaccine was administered.

Response

Read Immunization

get
/organizations/{organizationId}/fhir/3/Immunization/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Immunization

get
/organizations/{organizationId}/fhir/3/Immunization/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Immunization

get
/organizations/{organizationId}/fhir/3/Immunization/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Immunization

delete
/organizations/{organizationId}/fhir/3/Immunization/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Immunization

get
/organizations/{organizationId}/fhir/3/Immunization

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datestring
dose-sequencestring
identifierstring
locationstring
lot-numberstring
manufacturerstring
notgivenstring
patientstring
practitionerstring
reactionstring
reaction-datestring
reasonstring
reason-not-givenstring
statusstring
vaccine-codestring

Params

organizationId*string|stringid|slug

Response

Search History Immunization

get
/organizations/{organizationId}/fhir/3/Immunization/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Immunization

post
/organizations/{organizationId}/fhir/3/Immunization/_search

Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
datestring
dose-sequencestring
identifierstring
locationstring
lot-numberstring
manufacturerstring
notgivenstring
patientstring
practitionerstring
reactionstring
reaction-datestring
reasonstring
reason-not-givenstring
statusstring
vaccine-codestring

Params

organizationId*string|stringid|slug

Body

resourceType*stringImmunizationThis is a Immunization resource
identifierarray(Identifier)A unique identifier assigned to this immunization record.
statusstringIndicates the current status of the vaccination event.
notGivenbooleanIndicates if the vaccination was or was not given.
vaccineCode*CodeableConceptVaccine that was administered or was to be administered.
patient*ReferenceThe patient who either received or did not receive the immunization.
encounterReferenceThe visit or admission or other contact between patient and health care provider the immunization was performed as part of.
datestringDate vaccine administered or was to be administered.
primarySourcebooleanAn indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
reportOriginCodeableConceptThe source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
locationReferenceThe service delivery location where the vaccine administration occurred.
manufacturerReferenceName of vaccine manufacturer.
lotNumberstringLot number of the vaccine product.
expirationDatestringDate vaccine batch expires.
siteCodeableConceptBody site where vaccine was administered.
routeCodeableConceptThe path by which the vaccine product is taken into the body.
doseQuantityQuantityThe quantity of vaccine product that was administered.
practitionerarray(Immunization_Practitioner)Indicates who or what performed the event.
notearray(Annotation)Extra information about the immunization that is not conveyed by the other attributes.
explanationImmunization_ExplanationReasons why a vaccine was or was not administered.
reactionarray(Immunization_Reaction)Categorical data indicating that an adverse event is associated in time to an immunization.
vaccinationProtocolarray(Immunization_VaccinationProtocol)Contains information about the protocol(s) under which the vaccine was administered.

Response

Update Immunization

put
/organizations/{organizationId}/fhir/3/Immunization/{resourceId}

Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringImmunizationThis is a Immunization resource
identifierarray(Identifier)A unique identifier assigned to this immunization record.
statusstringIndicates the current status of the vaccination event.
notGivenbooleanIndicates if the vaccination was or was not given.
vaccineCode*CodeableConceptVaccine that was administered or was to be administered.
patient*ReferenceThe patient who either received or did not receive the immunization.
encounterReferenceThe visit or admission or other contact between patient and health care provider the immunization was performed as part of.
datestringDate vaccine administered or was to be administered.
primarySourcebooleanAn indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
reportOriginCodeableConceptThe source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
locationReferenceThe service delivery location where the vaccine administration occurred.
manufacturerReferenceName of vaccine manufacturer.
lotNumberstringLot number of the vaccine product.
expirationDatestringDate vaccine batch expires.
siteCodeableConceptBody site where vaccine was administered.
routeCodeableConceptThe path by which the vaccine product is taken into the body.
doseQuantityQuantityThe quantity of vaccine product that was administered.
practitionerarray(Immunization_Practitioner)Indicates who or what performed the event.
notearray(Annotation)Extra information about the immunization that is not conveyed by the other attributes.
explanationImmunization_ExplanationReasons why a vaccine was or was not administered.
reactionarray(Immunization_Reaction)Categorical data indicating that an adverse event is associated in time to an immunization.
vaccinationProtocolarray(Immunization_VaccinationProtocol)Contains information about the protocol(s) under which the vaccine was administered.

Response