Immunization.status

FHIR attribute (r4)

In the Immunization resource for FHIR r4 , the status attribute identifies the completed | entered-in-error | not-done

status (Immunization) description

Resource Type: Immunization

Attribute Name: status

Description: completed | entered-in-error | not-done

FHIR Version: r4

Attribute Type : code

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Immunization.status Example

"status": "completed"

Immunization 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 (Immunization) identifier FHIR attribute

Description: completed | entered-in-error | not-done

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 (Immunization) status FHIR attribute

Description: Reason not done

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:

"statusReason":

Learn more about the (Immunization) statusReason FHIR attribute

Description: Vaccine product administered

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:

"vaccineCode": {
  "coding": [
    {
      "system": "urn:oid:1.2.36.1.2001.1005.17",
      "code": "FLUVAX"
    }
  ],
  "text": "Fluvax (Influenza)"
}

Learn more about the (Immunization) vaccineCode FHIR attribute

Description: Who was immunized

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 (Immunization) patient FHIR attribute

Description: Encounter immunization was part of

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:

"encounter": {
  "reference": "Encounter/example"
}

Learn more about the (Immunization) encounter FHIR attribute

Description:

FHIR Version: r4

Attribute Type : dateTime|string

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"occurrence[x]":

Learn more about the (Immunization) occurrence[x] FHIR attribute

Description: When the immunization was first captured in the subject's record

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:

"recorded":

Learn more about the (Immunization) recorded FHIR attribute

Description: Indicates context the data was recorded in

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"primarySource": true

Learn more about the (Immunization) primarySource FHIR attribute

Description: Indicates the source of a secondarily reported record

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:

"reportOrigin":

Learn more about the (Immunization) reportOrigin FHIR attribute

Description: Where immunization occurred

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:

"location": {
  "reference": "Location/1"
}

Learn more about the (Immunization) location FHIR attribute

Description: Vaccine manufacturer

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:

"manufacturer": {
  "reference": "Organization/hl7"
}

Learn more about the (Immunization) manufacturer FHIR attribute

Description: Vaccine lot number

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:

"lotNumber": "AAJN11K"

Learn more about the (Immunization) lotNumber FHIR attribute

Description: Vaccine expiration date

FHIR Version: r4

Attribute Type : date

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"expirationDate": "2015-02-15"

Learn more about the (Immunization) expirationDate FHIR attribute

Description: Body site vaccine was administered

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:

"site": {
  "coding": [
    {
      "system": "http://terminology.hl7.org/CodeSystem/v3-ActSite",
      "code": "LA",
      "display": "left arm"
    }
  ]
}

Learn more about the (Immunization) site FHIR attribute

Description: How vaccine entered body

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:

"route": {
  "coding": [
    {
      "system": "http://terminology.hl7.org/CodeSystem/v3-RouteOfAdministration",
      "code": "IM",
      "display": "Injection, intramuscular"
    }
  ]
}

Learn more about the (Immunization) route FHIR attribute

Description: Amount of vaccine administered

FHIR Version: r4

Attribute Type : SimpleQuantity

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"doseQuantity": {
  "value": 5,
  "system": "http://unitsofmeasure.org",
  "code": "mg"
}

Learn more about the (Immunization) doseQuantity FHIR attribute

Description: Who performed event

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:

"performer": [
  {
    "function": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v2-0443",
          "code": "OP"
        }
      ]
    },
    "actor": {
      "reference": "Practitioner/example"
    }
  },
  {
    "function": {
      "coding": [
        {
          "system": "http://terminology.hl7.org/CodeSystem/v2-0443",
          "code": "AP"
        }
      ]
    },
    "actor": {
      "reference": "Practitioner/example"
    }
  }
]

Learn more about the (Immunization) performer FHIR attribute

Description: Additional immunization notes

FHIR Version: r4

Attribute Type : Annotation

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"note": [
  {
    "text": "Notes on adminstration of vaccine"
  }
]

Learn more about the (Immunization) note FHIR attribute

Description: Why immunization occurred

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:

"reasonCode": [
  {
    "coding": [
      {
        "system": "http://snomed.info/sct",
        "code": "429060002"
      }
    ]
  }
]

Learn more about the (Immunization) reasonCode FHIR attribute

Description: Why immunization occurred

FHIR Version: r4

Attribute Type : Reference

Required: N/A

Countability: Array

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"reasonReference":

Learn more about the (Immunization) reasonReference FHIR attribute

Description: Dose potency

FHIR Version: r4

Attribute Type : boolean

Required: N/A

Countability: Singleton

Flags: N/A

Terminology bindings: N/A

Requirements: N/A

Comments: N/A

Example:

"isSubpotent": true

Learn more about the (Immunization) isSubpotent FHIR attribute

Description: Reason for being subpotent

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:

"subpotentReason":

Learn more about the (Immunization) subpotentReason FHIR attribute

Description: Educational material presented to patient

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:

"education": [
  {
    "documentType": "253088698300010311120702",
    "publicationDate": "2012-07-02",
    "presentationDate": "2013-01-10"
  }
]

Learn more about the (Immunization) education FHIR attribute

Description: Patient eligibility for a vaccination program

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:

"programEligibility": [
  {
    "coding": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/immunization-program-eligibility",
        "code": "ineligible"
      }
    ]
  }
]

Learn more about the (Immunization) programEligibility FHIR attribute

Description: Funding source for the vaccine

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:

"fundingSource": {
  "coding": [
    {
      "system": "http://terminology.hl7.org/CodeSystem/immunization-funding-source",
      "code": "private"
    }
  ]
}

Learn more about the (Immunization) fundingSource FHIR attribute

Description: Details of a reaction that follows immunization

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: