This page is part of the International Patient Summary Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
SD.11 StructureDefinition-immunization-uv-ips
This profile represents the constraints applied to the Immunization resource by the International Patient Summary (IPS) FHIR Implementation Guide. A record of an immunization is represented in the patient summary as an instance of an Immunization resource constrained by this profile.
It describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party.
Two extensions are optionally used by this profile: (1) the first one provides the details about the assertion (e.g. who did the assertion, when was done); (2) The second one provides the list of diseases targeted by this vaccine.
The vaccinationProtocol has been removed by this version of the profile as pre-adoption of the R4.
Conformance resource variables defined here
SD.11.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/uv/ips/StructureDefinition/immunization-uv-ips
Published on Tue Mar 06 00:00:00 AEDT 2018 as a draft by .
This profile builds on Immunization
Summary
Mandatory: 0 element (17 nested mandatory elements)
Must-Support: 13 elements
Fixed Value: 10 elements
Prohibited: 5 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
- http://hl7.org/fhir/uv/ips/StructureDefinition/statement-uv-ips
- http://hl7.org/fhir/uv/ips/StructureDefinition/targetdiseases-immunization-uv-ips
Slices
This structure defines the following Slices:
- The element Immunization.vaccineCode.coding is sliced based on the value of value:system
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Immunization | ||||
  statement-uv-ips | 0..1 | (Complex) | Immunization Statement detail URL: http://hl7.org/fhir/uv/ips/StructureDefinition/statement-uv-ips | |
   extension | ..0 | |||
| targetdiseases-immunization-uv-ips | S | 0..* | CodeableConcept-uv-ips | Target disease URL: http://hl7.org/fhir/uv/ips/StructureDefinition/targetdiseases-immunization-uv-ips |
| status | S | Fixed Value: completed | ||
| notGiven | Fixed Value: true | |||
| vaccineCode | S | |||
 coding | coding-uv-ips | Slice: Unordered, Open by value:system | ||
 coding | coding-uv-ips | Pharmaceutical Product Identifier, Level 1 | ||
 system | 1.. | Fixed Value: http://hl7.org/fhir/sid/phpid-l1 | ||
| code | 1.. | |||
| coding | coding-uv-ips | Pharmaceutical Product Identifier, Level 2 | ||
| system | 1.. | Fixed Value: http://hl7.org/fhir/sid/phpid-l2 | ||
| code | 1.. | |||
| coding | coding-uv-ips | Pharmaceutical Product Identifier, Level 3 | ||
| system | 1.. | Fixed Value: http://hl7.org/fhir/sid/phpid-l3 | ||
| code | 1.. | |||
| coding | coding-uv-ips | Pharmaceutical Product Identifier, Level 4 | ||
| system | 1.. | Fixed Value: http://hl7.org/fhir/sid/phpid-l4 | ||
| code | 1.. | |||
| coding | S | coding-uv-ips | Medicinal Product Identifier | |
| system | 1.. | Fixed Value: http://hl7.org/fhir/sid/mpid | ||
| code | 1.. | |||
| display | Name of the Medicinal Product | |||
| coding | S | coding-uv-ips | Packaged Medicinal Product Identifier | |
| system | 1.. | Fixed Value: http://hl7.org/fhir/sid/pcid | ||
| code | 1.. | |||
| display | Name of the Packaged Medicinal Product | |||
| coding | ..1 | coding-uv-ips | WHO ATC classification Binding: WHOATC (required) | |
| system | 1.. | Fixed Value: http://www.whocc.no/atc | ||
| code | 1.. | |||
| coding | S | ..1 | coding-uv-ips | Absent Unknown Immunization Binding: IPSNoImmunizationInfo (required) |
| system | 1.. | Fixed Value: urn:oid:2.16.840.1.113883.3.1937.777.13.5.999.1 | ||
| code | 1.. | |||
 text | S | |||
| patient | S | |||
| reference | S | |||
| identifier | ..0 | |||
| date | S | 1.. | ||
| route | Binding: IPSRouteOfAdmin (required) | |||
| coding | coding-uv-ips | Binding: IPSRouteOfAdmin (required) | ||
| practitioner | S | ..1 | ||
| actor | S | |||
 reference | S | |||
| identifier | ..0 | |||
| vaccinationProtocol | ..0 | |||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization | I | 0..* | Immunization event information dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource imm-2: If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent. imm-1: If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present | |
 id | ΣI | 0..1 | id | Logical id of this artifact ele-1: All FHIR elements must have a @value or children |
| meta | ΣI | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| language | I | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) ele-1: All FHIR elements must have a @value or children |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation ele-1: All FHIR elements must have a @value or children |
 contained | 0..* | Resource | Contained, inline Resources | |
| statement-uv-ips | I | 0..1 | (Complex) | Immunization Statement detail URL: http://hl7.org/fhir/uv/ips/StructureDefinition/statement-uv-ips ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..1 | Extension | Assertion date and time of the statement ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
 id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| url | I | 1..1 | uri | "assertionDate" |
| valueDateTime | I | 0..1 | dateTime | Value of extension ele-1: All FHIR elements must have a @value or children |
| extension | I | 0..1 | Extension | Information source ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| url | I | 1..1 | uri | "informationSource" |
 valueReference | I | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole | Organization) | Value of extension ele-1: All FHIR elements must have a @value or children |
| url | I | 1..1 | uri | "http://hl7.org/fhir/uv/ips/StructureDefinition/statement-uv-ips" |
| targetdiseases-immunization-uv-ips | SI | 0..* | CodeableConcept-uv-ips | Target disease URL: http://hl7.org/fhir/uv/ips/StructureDefinition/targetdiseases-immunization-uv-ips ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| identifier | I | 0..* | Identifier | Business identifier ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) ele-1: All FHIR elements must have a @value or children |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General': http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General': 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children per-1: If present, start SHALL have a lower value than end |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| start | ΣI | 0..1 | dateTime | Starting time with inclusive boundary ele-1: All FHIR elements must have a @value or children |
| end | ΣI | 0..1 | dateTime | End time with inclusive boundary, if not ongoing ele-1: All FHIR elements must have a @value or children |
| assigner | ΣI | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| status | ?!SΣI | 1..1 | code | completed | entered-in-error Binding: Immunization Status Codes (required) ele-1: All FHIR elements must have a @value or children Fixed Value: completed |
| notGiven | ?!ΣI | 1..1 | boolean | Flag for whether immunization was given ele-1: All FHIR elements must have a @value or children Fixed Value: true |
| vaccineCode | SI | 1..1 | CodeableConcept | Vaccine product administered Binding: Vaccine Administered Value Set (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | coding-uv-ips | A reference to a code defined by a terminology system Slice: Unordered, Open by value:system ele-1: All FHIR elements must have a @value or children | |
| coding | ΣI | 0..* | coding-uv-ips | Pharmaceutical Product Identifier, Level 1 ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/phpid-l1 |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| coding | ΣI | 0..* | coding-uv-ips | Pharmaceutical Product Identifier, Level 2 ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/phpid-l2 |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| coding | ΣI | 0..* | coding-uv-ips | Pharmaceutical Product Identifier, Level 3 ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/phpid-l3 |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| coding | ΣI | 0..* | coding-uv-ips | Pharmaceutical Product Identifier, Level 4 ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/phpid-l4 |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| coding | SΣI | 0..* | coding-uv-ips | Medicinal Product Identifier ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/mpid |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Name of the Medicinal Product ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| coding | SΣI | 0..* | coding-uv-ips | Packaged Medicinal Product Identifier ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://hl7.org/fhir/sid/pcid |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Name of the Packaged Medicinal Product ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| coding | ΣI | 0..1 | coding-uv-ips | WHO ATC classification Binding: WHOATC (required) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: http://www.whocc.no/atc |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| coding | SΣI | 0..1 | coding-uv-ips | Absent Unknown Immunization Binding: IPSNoImmunizationInfo (required) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children Fixed Value: urn:oid:2.16.840.1.113883.3.1937.777.13.5.999.1 |
| version | ΣI | 0..1 | string | Version of the system - if relevant ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| translation | I | 0..* | (Complex) | Language Translation (Localization) URL: http://hl7.org/fhir/StructureDefinition/translation ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| value | 0..1 | Primitive value for string Max Length: 1048576 | ||
| text | SΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| patient | SI | 1..1 | Reference(Patient) | Who was immunized ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | SΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| encounter | I | 0..1 | Reference(Encounter) | Encounter administered as part of ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| date | SI | 1..1 | dateTime | Vaccination administration date ele-1: All FHIR elements must have a @value or children |
| primarySource | I | 1..1 | boolean | Indicates context the data was recorded in ele-1: All FHIR elements must have a @value or children |
| reportOrigin | I | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: Immunization Origin Codes (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| location | I | 0..1 | Reference(Location) | Where vaccination occurred ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| manufacturer | I | 0..1 | Reference(Organization) | Vaccine manufacturer ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| lotNumber | I | 0..1 | string | Vaccine lot number ele-1: All FHIR elements must have a @value or children |
| expirationDate | I | 0..1 | date | Vaccine expiration date ele-1: All FHIR elements must have a @value or children |
| site | I | 0..1 | CodeableConcept | Body site vaccine was administered Binding: Codes for Immunization Site of Administration (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | coding-uv-ips | A reference to a code defined by a terminology system Binding: IPSTargetSiteCode (preferred) ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| route | I | 0..1 | CodeableConcept | How vaccine entered body Binding: IPSRouteOfAdmin (required) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | coding-uv-ips | A reference to a code defined by a terminology system Binding: IPSRouteOfAdmin (required) ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| doseQuantity | I | 0..1 | SimpleQuantity | Amount of vaccine administered ele-1: All FHIR elements must have a @value or children qty-3: If a code for the unit is present, the system SHALL also be present sqty-1: The comparator is not used on a SimpleQuantity |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| value | ΣI | 0..1 | decimal | Numerical value (with implicit precision) ele-1: All FHIR elements must have a @value or children |
| unit | ΣI | 0..1 | string | Unit representation ele-1: All FHIR elements must have a @value or children |
| system | ΣI | 0..1 | uri | System that defines coded unit form ele-1: All FHIR elements must have a @value or children |
| code | ΣI | 0..1 | code | Coded form of the unit ele-1: All FHIR elements must have a @value or children |
| practitioner | SΣI | 0..1 | BackboneElement | Who performed event ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
 modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| role | ΣI | 0..1 | CodeableConcept | What type of performance was done Binding: Immunization Role Codes (extensible) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| actor | SΣI | 1..1 | Reference(Practitioner) | Individual who was performing ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | SΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| note | ΣI | 0..* | Annotation | Vaccination notes ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
 author[x] | ΣI | 0..1 | Reference(Practitioner | Patient | RelatedPerson), string | Individual responsible for the annotation ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| time | ΣI | 0..1 | dateTime | When the annotation was made ele-1: All FHIR elements must have a @value or children |
| text | I | 1..1 | string | The annotation - text content ele-1: All FHIR elements must have a @value or children |
| explanation | I | 0..1 | BackboneElement | Administration/non-administration reasons ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| reason | I | 0..* | CodeableConcept | Why immunization occurred Binding: Immunization Reason Codes (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| reasonNotGiven | I | 0..1 | CodeableConcept | Why immunization did not occur Binding: Immunization Reasons for Not Immunizing Codes (example) ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| coding | ΣI | 0..* | coding-uv-ips | A reference to a code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
| text | ΣI | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children |
| reaction | I | 0..* | BackboneElement | Details of a reaction that follows immunization ele-1: All FHIR elements must have a @value or children |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| date | I | 0..1 | dateTime | When reaction started ele-1: All FHIR elements must have a @value or children |
| detail | I | 0..1 | Reference(Observation) | Additional information on reaction ele-1: All FHIR elements must have a @value or children ref-1: SHALL have a contained resource if a local reference is provided |
| id | I | 0..1 | string | xml:id (or equivalent in JSON) ele-1: All FHIR elements must have a @value or children |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
| display | ΣI | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children |
| reported | I | 0..1 | boolean | Indicates self-reported reaction ele-1: All FHIR elements must have a @value or children |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
