immunization evaluations

Create Immunization Evaluation

post
/organizations/{organizationId}/fhir/4/ImmunizationEvaluation

Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.

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 ImmunizationEvaluation 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 evaluation record.
statuscodeIndicates the current status of the evaluation of the vaccination administration event.
patient*ReferenceThe individual for whom the evaluation is being done.
datedateTimeThe date the evaluation of the vaccine administration event was performed.
authorityReferenceIndicates the authority who published the protocol (e.g. ACIP).
targetDisease*CodeableConceptThe vaccine preventable disease the dose is being evaluated against.
immunizationEvent*ReferenceThe vaccine administration event being evaluated.
doseStatus*CodeableConceptIndicates if the dose is valid or not valid with respect to the published recommendations.
doseStatusReasonarray(CodeableConcept)Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.
descriptionstringAdditional information about the evaluation.
seriesstringOne possible path to achieve presumed immunity against a disease - within the context of an authority.
doseNumberPositiveIntnumberNominal position in a series.
doseNumberStringstringNominal position in a series.
seriesDosesPositiveIntnumberThe recommended number of doses to achieve immunity.
seriesDosesStringstringThe recommended number of doses to achieve immunity.

Response

Patch Immunization Evaluation

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

Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.

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 ImmunizationEvaluation 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 evaluation record.
statuscodeIndicates the current status of the evaluation of the vaccination administration event.
patient*ReferenceThe individual for whom the evaluation is being done.
datedateTimeThe date the evaluation of the vaccine administration event was performed.
authorityReferenceIndicates the authority who published the protocol (e.g. ACIP).
targetDisease*CodeableConceptThe vaccine preventable disease the dose is being evaluated against.
immunizationEvent*ReferenceThe vaccine administration event being evaluated.
doseStatus*CodeableConceptIndicates if the dose is valid or not valid with respect to the published recommendations.
doseStatusReasonarray(CodeableConcept)Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.
descriptionstringAdditional information about the evaluation.
seriesstringOne possible path to achieve presumed immunity against a disease - within the context of an authority.
doseNumberPositiveIntnumberNominal position in a series.
doseNumberStringstringNominal position in a series.
seriesDosesPositiveIntnumberThe recommended number of doses to achieve immunity.
seriesDosesStringstringThe recommended number of doses to achieve immunity.

Response

Read Immunization Evaluation

get
/organizations/{organizationId}/fhir/4/ImmunizationEvaluation/{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 Evaluation

get
/organizations/{organizationId}/fhir/4/ImmunizationEvaluation/{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 Evaluation

get
/organizations/{organizationId}/fhir/4/ImmunizationEvaluation/{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 Evaluation

delete
/organizations/{organizationId}/fhir/4/ImmunizationEvaluation/{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 Evaluation

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

Request

Headers

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

Query params

_idstring
_languagestring
datestring
dose-statusstring
identifierstring
immunization-eventstring
patientstring
statusstring
target-diseasestring

Params

organizationId*string|stringid|slug

Response

Search History Immunization Evaluation

get
/organizations/{organizationId}/fhir/4/ImmunizationEvaluation/_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 Evaluation

post
/organizations/{organizationId}/fhir/4/ImmunizationEvaluation/_search

Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.

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-statusstring
identifierstring
immunization-eventstring
patientstring
statusstring
target-diseasestring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a ImmunizationEvaluation 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 evaluation record.
statuscodeIndicates the current status of the evaluation of the vaccination administration event.
patient*ReferenceThe individual for whom the evaluation is being done.
datedateTimeThe date the evaluation of the vaccine administration event was performed.
authorityReferenceIndicates the authority who published the protocol (e.g. ACIP).
targetDisease*CodeableConceptThe vaccine preventable disease the dose is being evaluated against.
immunizationEvent*ReferenceThe vaccine administration event being evaluated.
doseStatus*CodeableConceptIndicates if the dose is valid or not valid with respect to the published recommendations.
doseStatusReasonarray(CodeableConcept)Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.
descriptionstringAdditional information about the evaluation.
seriesstringOne possible path to achieve presumed immunity against a disease - within the context of an authority.
doseNumberPositiveIntnumberNominal position in a series.
doseNumberStringstringNominal position in a series.
seriesDosesPositiveIntnumberThe recommended number of doses to achieve immunity.
seriesDosesStringstringThe recommended number of doses to achieve immunity.

Response

Update Immunization Evaluation

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

Describes a comparison of an immunization event against published recommendations to determine if the administration is "valid" in relation to those recommendations.

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 ImmunizationEvaluation 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 evaluation record.
statuscodeIndicates the current status of the evaluation of the vaccination administration event.
patient*ReferenceThe individual for whom the evaluation is being done.
datedateTimeThe date the evaluation of the vaccine administration event was performed.
authorityReferenceIndicates the authority who published the protocol (e.g. ACIP).
targetDisease*CodeableConceptThe vaccine preventable disease the dose is being evaluated against.
immunizationEvent*ReferenceThe vaccine administration event being evaluated.
doseStatus*CodeableConceptIndicates if the dose is valid or not valid with respect to the published recommendations.
doseStatusReasonarray(CodeableConcept)Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.
descriptionstringAdditional information about the evaluation.
seriesstringOne possible path to achieve presumed immunity against a disease - within the context of an authority.
doseNumberPositiveIntnumberNominal position in a series.
doseNumberStringstringNominal position in a series.
seriesDosesPositiveIntnumberThe recommended number of doses to achieve immunity.
seriesDosesStringstringThe recommended number of doses to achieve immunity.

Response