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*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug

Body


resourceType*		This is a Immunization resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	The 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.
implicitRules	uri	A 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.
language	code	The base language in which the resource is written.
text	Narrative	A 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.
contained	array(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.
extension	array(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.
modifierExtension	array(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).
identifier	array(Identifier)	A unique identifier assigned to this immunization record.
status	code	Indicates the current status of the immunization event.
statusReason	CodeableConcept	Indicates the reason the immunization event was not performed.
vaccineCode*	CodeableConcept	Vaccine that was administered or was to be administered.
patient*	Reference	The patient who either received or did not receive the immunization.
encounter	Reference	The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
occurrenceDateTime	string	Date vaccine administered or was to be administered.
occurrenceString	string	Date vaccine administered or was to be administered.
recorded	dateTime	The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
primarySource	boolean	An 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.
reportOrigin	CodeableConcept	The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
location	Reference	The service delivery location where the vaccine administration occurred.
manufacturer	Reference	Name of vaccine manufacturer.
lotNumber	string	Lot number of the vaccine product.
expirationDate	date	Date vaccine batch expires.
site	CodeableConcept	Body site where vaccine was administered.
route	CodeableConcept	The path by which the vaccine product is taken into the body.
doseQuantity	Quantity	The quantity of vaccine product that was administered.
performer	array(Immunization_Performer)	Indicates who performed the immunization event.
note	array(Annotation)	Extra information about the immunization that is not conveyed by the other attributes.
reasonCode	array(CodeableConcept)	Reasons why the vaccine was administered.
reasonReference	array(Reference)	Condition, Observation or DiagnosticReport that supports why the immunization was administered.
isSubpotent	boolean	Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
subpotentReason	array(CodeableConcept)	Reason why a dose is considered to be subpotent.
education	array(Immunization_Education)	Educational material presented to the patient (or guardian) at the time of vaccine administration.
programEligibility	array(CodeableConcept)	Indicates a patient's eligibility for a funding program.
fundingSource	CodeableConcept	Indicates 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).
reaction	array(Immunization_Reaction)	Categorical data indicating that an adverse event is associated in time to an immunization.
protocolApplied	array(Immunization_ProtocolApplied)	The protocol (set of recommendations) being followed by the provider who administered the dose.

Response

201 400 401 404

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*	string	application/json-patch+json	application/json-patch+json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*		This is a Immunization resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	The 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.
implicitRules	uri	A 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.
language	code	The base language in which the resource is written.
text	Narrative	A 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.
contained	array(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.
extension	array(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.
modifierExtension	array(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).
identifier	array(Identifier)	A unique identifier assigned to this immunization record.
status	code	Indicates the current status of the immunization event.
statusReason	CodeableConcept	Indicates the reason the immunization event was not performed.
vaccineCode*	CodeableConcept	Vaccine that was administered or was to be administered.
patient*	Reference	The patient who either received or did not receive the immunization.
encounter	Reference	The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
occurrenceDateTime	string	Date vaccine administered or was to be administered.
occurrenceString	string	Date vaccine administered or was to be administered.
recorded	dateTime	The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
primarySource	boolean	An 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.
reportOrigin	CodeableConcept	The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
location	Reference	The service delivery location where the vaccine administration occurred.
manufacturer	Reference	Name of vaccine manufacturer.
lotNumber	string	Lot number of the vaccine product.
expirationDate	date	Date vaccine batch expires.
site	CodeableConcept	Body site where vaccine was administered.
route	CodeableConcept	The path by which the vaccine product is taken into the body.
doseQuantity	Quantity	The quantity of vaccine product that was administered.
performer	array(Immunization_Performer)	Indicates who performed the immunization event.
note	array(Annotation)	Extra information about the immunization that is not conveyed by the other attributes.
reasonCode	array(CodeableConcept)	Reasons why the vaccine was administered.
reasonReference	array(Reference)	Condition, Observation or DiagnosticReport that supports why the immunization was administered.
isSubpotent	boolean	Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
subpotentReason	array(CodeableConcept)	Reason why a dose is considered to be subpotent.
education	array(Immunization_Education)	Educational material presented to the patient (or guardian) at the time of vaccine administration.
programEligibility	array(CodeableConcept)	Indicates a patient's eligibility for a funding program.
fundingSource	CodeableConcept	Indicates 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).
reaction	array(Immunization_Reaction)	Categorical data indicating that an adverse event is associated in time to an immunization.
protocolApplied	array(Immunization_ProtocolApplied)	The protocol (set of recommendations) being followed by the provider who administered the dose.

Response

200 201 400 401 404 409

Read Immunization

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read History Immunization

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 401 404

Read Version Immunization

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string	id\|slug
resourceId*
versionId*

Response

200 400 401 404

Remove Immunization

delete

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Response

200 204 400 401 404 409

Search Get Immunization

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
date	string
identifier	string
location	string
lot-number	string
manufacturer	string
patient	string
performer	string
reaction	string
reaction-date	string
reason-code	string
reason-reference	string
series	string
status	string
status-reason	string
target-disease	string
vaccine-code	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

Search History Immunization

get

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

Request

Headers


content-type*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_count	string
_since	string

Params


organizationId*	string\|string		id\|slug

Response

200 401 404

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*	string	application/json\|application/x-www-form-urlencoded	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Query params


_id	string
_language	string
date	string
identifier	string
location	string
lot-number	string
manufacturer	string
patient	string
performer	string
reaction	string
reaction-date	string
reason-code	string
reason-reference	string
series	string
status	string
status-reason	string
target-disease	string
vaccine-code	string

Params


organizationId*	string\|string		id\|slug

Body


resourceType*		This is a Immunization resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	The 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.
implicitRules	uri	A 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.
language	code	The base language in which the resource is written.
text	Narrative	A 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.
contained	array(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.
extension	array(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.
modifierExtension	array(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).
identifier	array(Identifier)	A unique identifier assigned to this immunization record.
status	code	Indicates the current status of the immunization event.
statusReason	CodeableConcept	Indicates the reason the immunization event was not performed.
vaccineCode*	CodeableConcept	Vaccine that was administered or was to be administered.
patient*	Reference	The patient who either received or did not receive the immunization.
encounter	Reference	The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
occurrenceDateTime	string	Date vaccine administered or was to be administered.
occurrenceString	string	Date vaccine administered or was to be administered.
recorded	dateTime	The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
primarySource	boolean	An 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.
reportOrigin	CodeableConcept	The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
location	Reference	The service delivery location where the vaccine administration occurred.
manufacturer	Reference	Name of vaccine manufacturer.
lotNumber	string	Lot number of the vaccine product.
expirationDate	date	Date vaccine batch expires.
site	CodeableConcept	Body site where vaccine was administered.
route	CodeableConcept	The path by which the vaccine product is taken into the body.
doseQuantity	Quantity	The quantity of vaccine product that was administered.
performer	array(Immunization_Performer)	Indicates who performed the immunization event.
note	array(Annotation)	Extra information about the immunization that is not conveyed by the other attributes.
reasonCode	array(CodeableConcept)	Reasons why the vaccine was administered.
reasonReference	array(Reference)	Condition, Observation or DiagnosticReport that supports why the immunization was administered.
isSubpotent	boolean	Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
subpotentReason	array(CodeableConcept)	Reason why a dose is considered to be subpotent.
education	array(Immunization_Education)	Educational material presented to the patient (or guardian) at the time of vaccine administration.
programEligibility	array(CodeableConcept)	Indicates a patient's eligibility for a funding program.
fundingSource	CodeableConcept	Indicates 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).
reaction	array(Immunization_Reaction)	Categorical data indicating that an adverse event is associated in time to an immunization.
protocolApplied	array(Immunization_ProtocolApplied)	The protocol (set of recommendations) being followed by the provider who administered the dose.

Response

200 401 404

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*	string	application/json\|application/json+fhir	application/json
log-cdata	string
log-cdata-format	string	kv\|json	kv
Authorization	string	Bearer <token>

Params


organizationId*	string\|string		id\|slug
resourceId*

Body


resourceType*		This is a Immunization resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	The 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.
implicitRules	uri	A 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.
language	code	The base language in which the resource is written.
text	Narrative	A 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.
contained	array(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.
extension	array(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.
modifierExtension	array(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).
identifier	array(Identifier)	A unique identifier assigned to this immunization record.
status	code	Indicates the current status of the immunization event.
statusReason	CodeableConcept	Indicates the reason the immunization event was not performed.
vaccineCode*	CodeableConcept	Vaccine that was administered or was to be administered.
patient*	Reference	The patient who either received or did not receive the immunization.
encounter	Reference	The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
occurrenceDateTime	string	Date vaccine administered or was to be administered.
occurrenceString	string	Date vaccine administered or was to be administered.
recorded	dateTime	The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
primarySource	boolean	An 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.
reportOrigin	CodeableConcept	The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
location	Reference	The service delivery location where the vaccine administration occurred.
manufacturer	Reference	Name of vaccine manufacturer.
lotNumber	string	Lot number of the vaccine product.
expirationDate	date	Date vaccine batch expires.
site	CodeableConcept	Body site where vaccine was administered.
route	CodeableConcept	The path by which the vaccine product is taken into the body.
doseQuantity	Quantity	The quantity of vaccine product that was administered.
performer	array(Immunization_Performer)	Indicates who performed the immunization event.
note	array(Annotation)	Extra information about the immunization that is not conveyed by the other attributes.
reasonCode	array(CodeableConcept)	Reasons why the vaccine was administered.
reasonReference	array(Reference)	Condition, Observation or DiagnosticReport that supports why the immunization was administered.
isSubpotent	boolean	Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
subpotentReason	array(CodeableConcept)	Reason why a dose is considered to be subpotent.
education	array(Immunization_Education)	Educational material presented to the patient (or guardian) at the time of vaccine administration.
programEligibility	array(CodeableConcept)	Indicates a patient's eligibility for a funding program.
fundingSource	CodeableConcept	Indicates 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).
reaction	array(Immunization_Reaction)	Categorical data indicating that an adverse event is associated in time to an immunization.
protocolApplied	array(Immunization_ProtocolApplied)	The protocol (set of recommendations) being followed by the provider who administered the dose.

Response

200 201 400 401 404 409