ImmunizationEvaluation - FHIR Resource (r4)


This ImmunizationEvaluation Resource uses the FHIR API standard for access and structure.

Validate an ImmunizationEvaluation FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
authorityfalseReference# Who is responsible for publishing the recommendations
datefalsedateTime# Date evaluation was performed
descriptionfalsestring# Evaluation notes
doseNumber[x]falsepositiveInt|string#undefined
doseStatusfalseCodeableConcept# Status of the dose relative to published recommendations
doseStatusReasontrueCodeableConcept# Reason for the dose status
identifiertrueIdentifier# Business identifier
immunizationEventfalseReference# Immunization being evaluated
patientfalseReference# Who this evaluation is for
seriesfalsestring# Name of vaccine series
seriesDoses[x]falsepositiveInt|string#undefined
statusfalsecode# completed | entered-in-error
targetDiseasefalseCodeableConcept# Evaluation target disease

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 ParameterField TypeResource Fields Searched
datedatedate
dose-statustextdoseStatus
identifiertextidentifier
immunization-eventreferenceimmunizationEvent
patientreferencepatient
statustextstatus
target-diseasetexttargetDisease