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* | 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 ImmunizationEvaluation 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 evaluation record. | |
status | code | Indicates the current status of the evaluation of the vaccination administration event. | |
patient* | Reference | The individual for whom the evaluation is being done. | |
date | dateTime | The date the evaluation of the vaccine administration event was performed. | |
authority | Reference | Indicates the authority who published the protocol (e.g. ACIP). | |
targetDisease* | CodeableConcept | The vaccine preventable disease the dose is being evaluated against. | |
immunizationEvent* | Reference | The vaccine administration event being evaluated. | |
doseStatus* | CodeableConcept | Indicates if the dose is valid or not valid with respect to the published recommendations. | |
doseStatusReason | array(CodeableConcept) | Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations. | |
description | string | Additional information about the evaluation. | |
series | string | One possible path to achieve presumed immunity against a disease - within the context of an authority. | |
doseNumberPositiveInt | number | Nominal position in a series. | |
doseNumberString | string | Nominal position in a series. | |
seriesDosesPositiveInt | number | The recommended number of doses to achieve immunity. | |
seriesDosesString | string | The recommended number of doses to achieve immunity. |
Response
keyboard_arrow_down
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* | 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 ImmunizationEvaluation 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 evaluation record. | |
status | code | Indicates the current status of the evaluation of the vaccination administration event. | |
patient* | Reference | The individual for whom the evaluation is being done. | |
date | dateTime | The date the evaluation of the vaccine administration event was performed. | |
authority | Reference | Indicates the authority who published the protocol (e.g. ACIP). | |
targetDisease* | CodeableConcept | The vaccine preventable disease the dose is being evaluated against. | |
immunizationEvent* | Reference | The vaccine administration event being evaluated. | |
doseStatus* | CodeableConcept | Indicates if the dose is valid or not valid with respect to the published recommendations. | |
doseStatusReason | array(CodeableConcept) | Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations. | |
description | string | Additional information about the evaluation. | |
series | string | One possible path to achieve presumed immunity against a disease - within the context of an authority. | |
doseNumberPositiveInt | number | Nominal position in a series. | |
doseNumberString | string | Nominal position in a series. | |
seriesDosesPositiveInt | number | The recommended number of doses to achieve immunity. | |
seriesDosesString | string | The recommended number of doses to achieve immunity. |
Response
keyboard_arrow_down
Read Immunization Evaluation
get
/organizations/{organizationId}/fhir/4/ImmunizationEvaluation/{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
keyboard_arrow_down
Read History Immunization Evaluation
get
/organizations/{organizationId}/fhir/4/ImmunizationEvaluation/{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
keyboard_arrow_down
Read Version Immunization Evaluation
get
/organizations/{organizationId}/fhir/4/ImmunizationEvaluation/{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
keyboard_arrow_down
Remove Immunization Evaluation
delete
/organizations/{organizationId}/fhir/4/ImmunizationEvaluation/{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
keyboard_arrow_down
Search Get Immunization Evaluation
get
/organizations/{organizationId}/fhir/4/ImmunizationEvaluation
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 | |||
dose-status | string | ||
identifier | string | ||
immunization-event | string | ||
patient | string | ||
status | string | ||
target-disease | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Immunization Evaluation
get
/organizations/{organizationId}/fhir/4/ImmunizationEvaluation/_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
keyboard_arrow_down
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* | 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 | |||
dose-status | string | ||
identifier | string | ||
immunization-event | string | ||
patient | string | ||
status | string | ||
target-disease | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a ImmunizationEvaluation 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 evaluation record. | |
status | code | Indicates the current status of the evaluation of the vaccination administration event. | |
patient* | Reference | The individual for whom the evaluation is being done. | |
date | dateTime | The date the evaluation of the vaccine administration event was performed. | |
authority | Reference | Indicates the authority who published the protocol (e.g. ACIP). | |
targetDisease* | CodeableConcept | The vaccine preventable disease the dose is being evaluated against. | |
immunizationEvent* | Reference | The vaccine administration event being evaluated. | |
doseStatus* | CodeableConcept | Indicates if the dose is valid or not valid with respect to the published recommendations. | |
doseStatusReason | array(CodeableConcept) | Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations. | |
description | string | Additional information about the evaluation. | |
series | string | One possible path to achieve presumed immunity against a disease - within the context of an authority. | |
doseNumberPositiveInt | number | Nominal position in a series. | |
doseNumberString | string | Nominal position in a series. | |
seriesDosesPositiveInt | number | The recommended number of doses to achieve immunity. | |
seriesDosesString | string | The recommended number of doses to achieve immunity. |
Response
keyboard_arrow_down
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* | 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 ImmunizationEvaluation 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 evaluation record. | |
status | code | Indicates the current status of the evaluation of the vaccination administration event. | |
patient* | Reference | The individual for whom the evaluation is being done. | |
date | dateTime | The date the evaluation of the vaccine administration event was performed. | |
authority | Reference | Indicates the authority who published the protocol (e.g. ACIP). | |
targetDisease* | CodeableConcept | The vaccine preventable disease the dose is being evaluated against. | |
immunizationEvent* | Reference | The vaccine administration event being evaluated. | |
doseStatus* | CodeableConcept | Indicates if the dose is valid or not valid with respect to the published recommendations. | |
doseStatusReason | array(CodeableConcept) | Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations. | |
description | string | Additional information about the evaluation. | |
series | string | One possible path to achieve presumed immunity against a disease - within the context of an authority. | |
doseNumberPositiveInt | number | Nominal position in a series. | |
doseNumberString | string | Nominal position in a series. | |
seriesDosesPositiveInt | number | The recommended number of doses to achieve immunity. | |
seriesDosesString | string | The recommended number of doses to achieve immunity. |
Response
keyboard_arrow_down