This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: Immunization

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/medicationadministration-immunization-immunization

This profile is how to represent and immunization record using the medication administration resource

This profile was published on Wed, Mar 18, 2015 00:00+1100 as a draft by Health Level Seven, Inc. - [WG Name] WG.

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from MedicationAdministration.

unable to summarise extension (wrong count)

This structure is derived from MedicationAdministration.

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 1..1MedicationAdministrationneeds something here.
... status codeFixed Value: completed
... prescription
... reasonNotGiven Binding: NoImmunizationReason (example)
... reasonGiven Binding: ImmunizationReason (example)
... effectiveTime[x] dateTime
... medication immunization-Vaccine
... device 0..0
... dosage 1..1
.... text 0..0
.... site Binding: ImmunizationSite (example)
.... route Binding: ImmunizationRoute (example)
.... method 0..0
.... rate 0..0
... immunization-reported 0..1booleanTrue if this administration was reported
... immunization-reaction 0..*(Complex)Details of a reaction that follows immunization
... immunization-protocol 0..*(Complex)What protocol was followed
NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 1..1MedicationAdministrationneeds something here.
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... immunization-reported 0..1booleanExtension
... immunization-reaction 0..*(Complex)Extension
... immunization-protocol 0..*(Complex)Extension
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal identifier
... status 1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
Fixed Value: completed
... patient 1..1PatientWho received medication?
... practitioner 0..1PractitionerWho administered substance?
... encounter 0..1EncounterEncounter administered as part of
... prescription 0..1MedicationPrescriptionOrder administration performed against
... wasNotGiven ?!0..1booleanTrue if medication not administered
... reasonNotGiven I0..*CodeableConceptReason administration not performed
Binding: NoImmunizationReason (example)
mad-2: Reason not given is only permitted if wasNotGiven is true
... reasonGiven I0..*CodeableConceptReason administration performed
Binding: ImmunizationReason (example)
mad-3: Reason given is only permitted if wasNotGiven is false
... effectiveTimeDateTime 1..1dateTimeStart and end time of administration
... medication 0..1immunization-VaccineWhat was administered?
... note 0..1stringInformation about the administration
... dosage I1..1Details of how medication was taken
mad-1: SHALL have at least one of dosage.quantity and dosage.rate
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... site 0..1CodeableConceptBody site administered to
Binding: ImmunizationSite (example)
.... route 0..1CodeableConceptPath of substance into body
Binding: ImmunizationRoute (example)
.... quantity 0..1QuantityAmount administered in one dose

todo

This structure is derived from MedicationAdministration.

unable to summarise extension (wrong count)

Differential View

This structure is derived from MedicationAdministration.

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 1..1MedicationAdministrationneeds something here.
... status codeFixed Value: completed
... prescription
... reasonNotGiven Binding: NoImmunizationReason (example)
... reasonGiven Binding: ImmunizationReason (example)
... effectiveTime[x] dateTime
... medication immunization-Vaccine
... device 0..0
... dosage 1..1
.... text 0..0
.... site Binding: ImmunizationSite (example)
.... route Binding: ImmunizationRoute (example)
.... method 0..0
.... rate 0..0
... immunization-reported 0..1booleanTrue if this administration was reported
... immunization-reaction 0..*(Complex)Details of a reaction that follows immunization
... immunization-protocol 0..*(Complex)What protocol was followed

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MedicationAdministration 1..1MedicationAdministrationneeds something here.
... meta 0..1MetaMetadata about the resource
... implicitRules ?!0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... immunization-reported 0..1booleanExtension
... immunization-reaction 0..*(Complex)Extension
... immunization-protocol 0..*(Complex)Extension
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier 0..*IdentifierExternal identifier
... status 1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
Fixed Value: completed
... patient 1..1PatientWho received medication?
... practitioner 0..1PractitionerWho administered substance?
... encounter 0..1EncounterEncounter administered as part of
... prescription 0..1MedicationPrescriptionOrder administration performed against
... wasNotGiven ?!0..1booleanTrue if medication not administered
... reasonNotGiven I0..*CodeableConceptReason administration not performed
Binding: NoImmunizationReason (example)
mad-2: Reason not given is only permitted if wasNotGiven is true
... reasonGiven I0..*CodeableConceptReason administration performed
Binding: ImmunizationReason (example)
mad-3: Reason given is only permitted if wasNotGiven is false
... effectiveTimeDateTime 1..1dateTimeStart and end time of administration
... medication 0..1immunization-VaccineWhat was administered?
... note 0..1stringInformation about the administration
... dosage I1..1Details of how medication was taken
mad-1: SHALL have at least one of dosage.quantity and dosage.rate
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... site 0..1CodeableConceptBody site administered to
Binding: ImmunizationSite (example)
.... route 0..1CodeableConceptPath of substance into body
Binding: ImmunizationRoute (example)
.... quantity 0..1QuantityAmount administered in one dose

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

Terminology Bindings

PathNameConformanceValueSet
MedicationAdministration.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
MedicationAdministration.statusMedicationAdministrationStatusrequiredMedicationAdministrationStatus
MedicationAdministration.reasonNotGivenNoImmunizationReasonexampleImmunization Reasons for Not Immunizing Codes
MedicationAdministration.reasonGivenImmunizationReasonexampleImmunization Reason Codes
MedicationAdministration.dosage.siteImmunizationSiteexampleCodes for Immunization Site of Administration
MedicationAdministration.dosage.routeImmunizationRouteexampleImmunization Route Codes
MedicationAdministration.dosage.methodMedicationAdministrationMethodexampleSNOMED CT Introduction (procedure) for Administration Method Codes

Constraints

IdPathNameDetails
mad-2MedicationAdministration.reasonNotGivenNot given reasonReason not given is only permitted if wasNotGiven is true
XPath: not(exists(f:reasonNotGiven) and f:wasNotGiven/@value='false')
mad-3MedicationAdministration.reasonGivenGiven reasonReason given is only permitted if wasNotGiven is false
XPath: not(exists(f:reasonGiven) and f:wasNotGiven/@value='true')
mad-1MedicationAdministration.dosageDoseSHALL have at least one of dosage.quantity and dosage.rate
XPath: exists(f:quantity) or exists(f:rate)
.