ImmunizationEvaluation - FHIR Resource (r4)
This ImmunizationEvaluation Resource uses the FHIR API standard for access and structure.
Validate an ImmunizationEvaluation FHIR Resource (r4)
ImmunizationEvaluation Attributes
AttributeField is listTypeDescription
Description: Business identifier
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
}
]Learn more about the (ImmunizationEvaluation) identifier FHIR attribute
Description: completed | entered-in-error
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "completed"Learn more about the (ImmunizationEvaluation) status FHIR attribute
Description: Who this evaluation is for
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patient": {
"reference": "Patient/example"
}Learn more about the (ImmunizationEvaluation) patient FHIR attribute
Description: Date evaluation was performed
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"date": "2013-01-10"Learn more about the (ImmunizationEvaluation) date FHIR attribute
Description: Who is responsible for publishing the recommendations
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"authority": {
"reference": "Organization/hl7"
}Learn more about the (ImmunizationEvaluation) authority FHIR attribute
Description: Evaluation target disease
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"targetDisease": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "1857005"
}
]
}Learn more about the (ImmunizationEvaluation) targetDisease FHIR attribute
Description: Immunization being evaluated
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"immunizationEvent": {
"reference": "Immunization/example"
}Learn more about the (ImmunizationEvaluation) immunizationEvent FHIR attribute
Description: Status of the dose relative to published recommendations
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"doseStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-evaluation-dose-status",
"code": "valid",
"display": "Valid"
}
]
}Learn more about the (ImmunizationEvaluation) doseStatus FHIR attribute
Description: Reason for the dose status
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"doseStatusReason": Learn more about the (ImmunizationEvaluation) doseStatusReason FHIR attribute
Description: Evaluation notes
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"description": Learn more about the (ImmunizationEvaluation) description FHIR attribute
Description: Name of vaccine series
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"series": "Vaccination Series 1"Learn more about the (ImmunizationEvaluation) series FHIR attribute
Description:
FHIR Version: r4
Attribute Type : positiveInt|string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"doseNumber[x]": Learn more about the (ImmunizationEvaluation) doseNumber[x] FHIR attribute
Description:
FHIR Version: r4
Attribute Type : positiveInt|string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"seriesDoses[x]": Learn more about the (ImmunizationEvaluation) seriesDoses[x] FHIR attribute
ImmunizationEvaluation Example
{
"resourceType": "ImmunizationEvaluation",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234</p><p><b>status</b>: completed</p><p><b>patient</b>: <a>Patient/example</a></p><p><b>date</b>: 10/01/2013</p><p><b>authority</b>: <a>Organization/hl7</a></p><p><b>targetDisease</b>: Gestational rubella syndrome <span>(Details : {SNOMED CT code '1857005' = 'Gestational rubella syndrome)</span></p><p><b>immunizationEvent</b>: <a>Immunization/example</a></p><p><b>doseStatus</b>: Valid <span>(Details : {http://terminology.hl7.org/CodeSystem/immunization-evaluation-dose-status code 'valid' = 'Valid', given as 'Valid'})</span></p><p><b>series</b>: Vaccination Series 1</p><p><b>doseNumber</b>: 1</p><p><b>seriesDoses</b>: 3</p></div>"
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1234"
}
],
"status": "completed",
"patient": {
"reference": "Patient/example"
},
"date": "2013-01-10",
"authority": {
"reference": "Organization/hl7"
},
"targetDisease": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "1857005"
}
]
},
"immunizationEvent": {
"reference": "Immunization/example"
},
"doseStatus": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/immunization-evaluation-dose-status",
"code": "valid",
"display": "Valid"
}
]
},
"series": "Vaccination Series 1",
"doseNumberPositiveInt": 1,
"seriesDosesPositiveInt": 3
}ImmunizationEvaluation Structure
{
"resourceType" : "ImmunizationEvaluation",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier
"status" : "<code>", // R! completed | entered-in-error
"patient" : { Reference(Patient) }, // R! Who this evaluation is for
"date" : "<dateTime>", // Date evaluation was performed
"authority" : { Reference(Organization) }, // Who is responsible for publishing the recommendations
"targetDisease" : { CodeableConcept }, // R! Evaluation target disease
"immunizationEvent" : { Reference(Immunization) }, // R! Immunization being evaluated
"doseStatus" : { CodeableConcept }, // R! Status of the dose relative to published recommendations
"doseStatusReason" : [{ CodeableConcept }], // Reason for the dose status
"description" : "<string>", // Evaluation notes
"series" : "<string>", // Name of vaccine series
// doseNumber[x]: Dose number within series. One of these 2:
"doseNumberPositiveInt" : "<positiveInt>",
"doseNumberString" : "<string>",
// seriesDoses[x]: Recommended number of doses for immunity. One of these 2:
"seriesDosesPositiveInt" : "<positiveInt>"
"seriesDosesString" : "<string>"
}
ImmunizationEvaluation Search Parameters
The following search parameters can be used to query ImmunizationEvaluation resources. Just submit them like so:
https://api.1up.health/fhir/r4/ImmunizationEvaluation?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
date | date | date |
dose-status | text | doseStatus |
identifier | text | identifier |
immunization-event | reference | immunizationEvent |
patient | reference | patient |
status | text | status |
target-disease | text | targetDisease |
