immunizations

Create Immunization

post
/organizations/{organizationId}/fhir/4/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.

Request

Headers

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

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Immunization resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)A unique identifier assigned to this immunization record.
statuscodeIndicates the current status of the immunization event.
statusReasonCodeableConceptIndicates the reason the immunization event was not performed.
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.
occurrenceDateTimestringDate vaccine administered or was to be administered.
occurrenceStringstringDate vaccine administered or was to be administered.
recordeddateTimeThe date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
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.
expirationDatedateDate 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.
performerarray(Immunization_Performer)Indicates who performed the immunization event.
notearray(Annotation)Extra information about the immunization that is not conveyed by the other attributes.
reasonCodearray(CodeableConcept)Reasons why the vaccine was administered.
reasonReferencearray(Reference)Condition, Observation or DiagnosticReport that supports why the immunization was administered.
isSubpotentbooleanIndication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
subpotentReasonarray(CodeableConcept)Reason why a dose is considered to be subpotent.
educationarray(Immunization_Education)Educational material presented to the patient (or guardian) at the time of vaccine administration.
programEligibilityarray(CodeableConcept)Indicates a patient's eligibility for a funding program.
fundingSourceCodeableConceptIndicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).
reactionarray(Immunization_Reaction)Categorical data indicating that an adverse event is associated in time to an immunization.
protocolAppliedarray(Immunization_ProtocolApplied)The protocol (set of recommendations) being followed by the provider who administered the dose.

Response

Patch Immunization

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

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.

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*This is a Immunization resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)A unique identifier assigned to this immunization record.
statuscodeIndicates the current status of the immunization event.
statusReasonCodeableConceptIndicates the reason the immunization event was not performed.
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.
occurrenceDateTimestringDate vaccine administered or was to be administered.
occurrenceStringstringDate vaccine administered or was to be administered.
recordeddateTimeThe date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
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.
expirationDatedateDate 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.
performerarray(Immunization_Performer)Indicates who performed the immunization event.
notearray(Annotation)Extra information about the immunization that is not conveyed by the other attributes.
reasonCodearray(CodeableConcept)Reasons why the vaccine was administered.
reasonReferencearray(Reference)Condition, Observation or DiagnosticReport that supports why the immunization was administered.
isSubpotentbooleanIndication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
subpotentReasonarray(CodeableConcept)Reason why a dose is considered to be subpotent.
educationarray(Immunization_Education)Educational material presented to the patient (or guardian) at the time of vaccine administration.
programEligibilityarray(CodeableConcept)Indicates a patient's eligibility for a funding program.
fundingSourceCodeableConceptIndicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).
reactionarray(Immunization_Reaction)Categorical data indicating that an adverse event is associated in time to an immunization.
protocolAppliedarray(Immunization_ProtocolApplied)The protocol (set of recommendations) being followed by the provider who administered the dose.

Response

Read Immunization

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Immunization

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/Immunization/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Immunization

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Immunization

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

Request

Headers

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

Query params

_idstring
_languagestring
datestring
identifierstring
locationstring
lot-numberstring
manufacturerstring
patientstring
performerstring
reactionstring
reaction-datestring
reason-codestring
reason-referencestring
seriesstring
statusstring
status-reasonstring
target-diseasestring
vaccine-codestring

Params

organizationId*string|stringid|slug

Response

Search History Immunization

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/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/4/Immunization/_search

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.

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
identifierstring
locationstring
lot-numberstring
manufacturerstring
patientstring
performerstring
reactionstring
reaction-datestring
reason-codestring
reason-referencestring
seriesstring
statusstring
status-reasonstring
target-diseasestring
vaccine-codestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a Immunization resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)A unique identifier assigned to this immunization record.
statuscodeIndicates the current status of the immunization event.
statusReasonCodeableConceptIndicates the reason the immunization event was not performed.
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.
occurrenceDateTimestringDate vaccine administered or was to be administered.
occurrenceStringstringDate vaccine administered or was to be administered.
recordeddateTimeThe date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
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.
expirationDatedateDate 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.
performerarray(Immunization_Performer)Indicates who performed the immunization event.
notearray(Annotation)Extra information about the immunization that is not conveyed by the other attributes.
reasonCodearray(CodeableConcept)Reasons why the vaccine was administered.
reasonReferencearray(Reference)Condition, Observation or DiagnosticReport that supports why the immunization was administered.
isSubpotentbooleanIndication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
subpotentReasonarray(CodeableConcept)Reason why a dose is considered to be subpotent.
educationarray(Immunization_Education)Educational material presented to the patient (or guardian) at the time of vaccine administration.
programEligibilityarray(CodeableConcept)Indicates a patient's eligibility for a funding program.
fundingSourceCodeableConceptIndicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).
reactionarray(Immunization_Reaction)Categorical data indicating that an adverse event is associated in time to an immunization.
protocolAppliedarray(Immunization_ProtocolApplied)The protocol (set of recommendations) being followed by the provider who administered the dose.

Response

Update Immunization

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

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.

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a Immunization resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRulesuriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
languagecodeThe base language in which the resource is written.
textNarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
containedarray(ResourceList)These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtensionarray(Extension)May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifierarray(Identifier)A unique identifier assigned to this immunization record.
statuscodeIndicates the current status of the immunization event.
statusReasonCodeableConceptIndicates the reason the immunization event was not performed.
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.
occurrenceDateTimestringDate vaccine administered or was to be administered.
occurrenceStringstringDate vaccine administered or was to be administered.
recordeddateTimeThe date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
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.
expirationDatedateDate 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.
performerarray(Immunization_Performer)Indicates who performed the immunization event.
notearray(Annotation)Extra information about the immunization that is not conveyed by the other attributes.
reasonCodearray(CodeableConcept)Reasons why the vaccine was administered.
reasonReferencearray(Reference)Condition, Observation or DiagnosticReport that supports why the immunization was administered.
isSubpotentbooleanIndication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
subpotentReasonarray(CodeableConcept)Reason why a dose is considered to be subpotent.
educationarray(Immunization_Education)Educational material presented to the patient (or guardian) at the time of vaccine administration.
programEligibilityarray(CodeableConcept)Indicates a patient's eligibility for a funding program.
fundingSourceCodeableConceptIndicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).
reactionarray(Immunization_Reaction)Categorical data indicating that an adverse event is associated in time to an immunization.
protocolAppliedarray(Immunization_ProtocolApplied)The protocol (set of recommendations) being followed by the provider who administered the dose.

Response