ImmunizationRecommendation - FHIR Resource (r4)
This ImmunizationRecommendation Resource uses the FHIR API standard for access and structure.
Validate an ImmunizationRecommendation FHIR Resource (r4)
ImmunizationRecommendation 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.1235"
}
]Learn more about the (ImmunizationRecommendation) identifier FHIR attribute
Description: Who this profile 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 (ImmunizationRecommendation) patient FHIR attribute
Description: Date recommendation(s) created
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": "2015-02-09T11:04:15.817-05:00"Learn more about the (ImmunizationRecommendation) date FHIR attribute
Description: Who is responsible for protocol
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 (ImmunizationRecommendation) authority FHIR attribute
Description: Vaccine administration recommendations
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"recommendation": [
{
"vaccineCode": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "14745005",
"display": "Hepatitis A vaccine"
}
]
}
],
"forecastStatus": {
"text": "Not Complete"
},
"dateCriterion": [
{
"code": {
"coding": [
{
"system": "http://example.org/fhir/CodeSystem/immunization-recommendation-date-criterion",
"code": "earliest",
"display": "Earliest Date"
}
]
},
"value": "2015-12-01T00:00:00-05:00"
},
{
"code": {
"coding": [
{
"system": "http://example.org/fhir/CodeSystem/immunization-recommendation-date-criterion",
"code": "recommended",
"display": "Recommended"
}
]
},
"value": "2015-12-01T00:00:00-05:00"
},
{
"code": {
"coding": [
{
"system": "http://example.org/fhir/CodeSystem/immunization-recommendation-date-criterion",
"code": "overdue",
"display": "Past Due Date"
}
]
},
"value": "2016-12-28T00:00:00-05:00"
}
],
"description": "First sequence in protocol",
"series": "Vaccination Series 1",
"doseNumberPositiveInt": 1,
"seriesDosesPositiveInt": 3,
"supportingImmunization": [
{
"reference": "Immunization/example"
}
],
"supportingPatientInformation": [
{
"reference": "Observation/example"
}
]
}
]Learn more about the (ImmunizationRecommendation) recommendation FHIR attribute
ImmunizationRecommendation Example
{
"resourceType": "ImmunizationRecommendation",
"id": "example",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">Authored by Joginder Madra</div>"
},
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:1.3.6.1.4.1.21367.2005.3.7.1235"
}
],
"patient": {
"reference": "Patient/example"
},
"date": "2015-02-09T11:04:15.817-05:00",
"authority": {
"reference": "Organization/hl7"
},
"recommendation": [
{
"vaccineCode": [
{
"coding": [
{
"system": "http://snomed.info/sct",
"code": "14745005",
"display": "Hepatitis A vaccine"
}
]
}
],
"forecastStatus": {
"text": "Not Complete"
},
"dateCriterion": [
{
"code": {
"coding": [
{
"system": "http://example.org/fhir/CodeSystem/immunization-recommendation-date-criterion",
"code": "earliest",
"display": "Earliest Date"
}
]
},
"value": "2015-12-01T00:00:00-05:00"
},
{
"code": {
"coding": [
{
"system": "http://example.org/fhir/CodeSystem/immunization-recommendation-date-criterion",
"code": "recommended",
"display": "Recommended"
}
]
},
"value": "2015-12-01T00:00:00-05:00"
},
{
"code": {
"coding": [
{
"system": "http://example.org/fhir/CodeSystem/immunization-recommendation-date-criterion",
"code": "overdue",
"display": "Past Due Date"
}
]
},
"value": "2016-12-28T00:00:00-05:00"
}
],
"description": "First sequence in protocol",
"series": "Vaccination Series 1",
"doseNumberPositiveInt": 1,
"seriesDosesPositiveInt": 3,
"supportingImmunization": [
{
"reference": "Immunization/example"
}
],
"supportingPatientInformation": [
{
"reference": "Observation/example"
}
]
}
]
}ImmunizationRecommendation Structure
{
"resourceType" : "ImmunizationRecommendation",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Business identifier
"patient" : { Reference(Patient) }, // R! Who this profile is for
"date" : "<dateTime>", // R! Date recommendation(s) created
"authority" : { Reference(Organization) }, // Who is responsible for protocol
"recommendation" : [{ // R! Vaccine administration recommendations
"vaccineCode" : [{ CodeableConcept }], // Vaccine or vaccine group recommendation applies to
"targetDisease" : { CodeableConcept }, // Disease to be immunized against
"contraindicatedVaccineCode" : [{ CodeableConcept }], // Vaccine which is contraindicated to fulfill the recommendation
"forecastStatus" : { CodeableConcept }, // R! Vaccine recommendation status
"forecastReason" : [{ CodeableConcept }], // Vaccine administration status reason
"dateCriterion" : [{ // Dates governing proposed immunization
"code" : { CodeableConcept }, // R! Type of date
"value" : "<dateTime>" // R! Recommended date
}],
"description" : "<string>", // Protocol details
"series" : "<string>", // Name of vaccination series
// doseNumber[x]: Recommended 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>",
"supportingImmunization" : [{ Reference(Immunization|ImmunizationEvaluation) }], // Past immunizations supporting recommendation
"supportingPatientInformation" : [{ Reference(Any) }] // Patient observations supporting recommendation
}]
}
ImmunizationRecommendation Search Parameters
The following search parameters can be used to query ImmunizationRecommendation resources. Just submit them like so:
https://api.1up.health/fhir/r4/ImmunizationRecommendation?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
date | date | date |
identifier | text | identifier |
information | reference | recommendation.supportingPatientInformation |
patient | reference | patient |
status | text | recommendation.forecastStatus |
support | reference | recommendation.supportingImmunization |
target-disease | text | recommendation.targetDisease |
vaccine-type | text | recommendation.vaccineCode |
