HL7 FHIR® UK Core - Local Development build (v4.0.0). See the Directory of published versions
StructureDefinition: UKCoreImmunization
Defines the UK Core constraints and extensions on the Immunization resource for the minimal set of data to query and retrieve an individual’s immunisation information.
The official URL for this profile is:
https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Immunization
Formal Views of Profile Content
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Immunization
Summary
Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 1 element
Structures
This structure refers to these other structures:
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Organization
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Patient
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Encounter
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Location
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Practitioner
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Condition
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Observation
Slices
This structure defines the following Slices:
- The element Immunization.route.coding is sliced based on the value of value:system
This structure is derived from Immunization
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Immunization | I | 0..* | Immunization | Immunization event information |
  id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
 identifier | I | 0..* | Identifier | Business identifier |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
  assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| status | ?!ΣI | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) |
| statusReason | I | 0..1 | CodeableConcept | Reason not done Binding: UK Core Reason Immunization Not Administered (extensible) |
| vaccineCode | ΣI | 1..1 | CodeableConcept | Vaccine product administered Binding: UK Core Vaccine Code (extensible) |
| patient | ΣI | 1..1 | Reference(UK Core Patient) | Who was immunized |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| encounter | I | 0..1 | Reference(UK Core Encounter) | Encounter immunization was part of |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
 occurrence[x] | ΣI | 1..1 | Vaccine administration date | |
| occurrenceDateTime | dateTime | |||
| occurrenceString | string | |||
| recorded | I | 0..1 | dateTime | When the immunization was first captured in the subject's record |
| primarySource | ΣI | 0..1 | boolean | Indicates context the data was recorded in |
| reportOrigin | I | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example) |
| location | I | 0..1 | Reference(UK Core Location) | Where immunization occurred |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| manufacturer | I | 0..1 | Reference(UK Core Organization) | Vaccine manufacturer |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| lotNumber | I | 0..1 | string | Vaccine lot number |
| expirationDate | I | 0..1 | date | Vaccine expiration date |
| site | I | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example) |
| route | I | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
 coding | ΣI | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
  coding:snomedCT | ΣI | 0..* | Coding | Code defined by a terminology system Binding: UK Core Medication Dosage Route (extensible) |
  id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | ΣI | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system |
| display | ΣI | 1..1 | string | Representation defined by the system |
 userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| doseQuantity | I | 0..1 | SimpleQuantity | Amount of vaccine administered |
| performer | ΣI | 0..* | BackboneElement | Who performed event |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | ΣI | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible) |
| actor | ΣI | 1..1 | Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core Organization) | Individual or organization who was performing |
| note | ΣI | 0..* | Annotation | Additional immunization notes |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| author[x] | ΣI | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization) | |||
| authorString | string | |||
| time | ΣI | 0..1 | dateTime | When the annotation was made |
| text | ΣI | 1..1 | markdown | The annotation - text content (as markdown) |
| reasonCode | I | 0..* | CodeableConcept | Why immunization occurred Binding: UK Core Immunization Explanation Reason (extensible) |
| reasonReference | I | 0..* | Reference(UK Core Condition | UK Core Observation | UKCore DiagnosticReport) | Why immunization occurred |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| isSubpotent | ?!ΣI | 0..1 | boolean | Dose potency |
| subpotentReason | I | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example) |
| education | I | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| documentType | I | 0..1 | string | Educational material document identifier |
| reference | I | 0..1 | uri | Educational material reference pointer |
| publicationDate | I | 0..1 | dateTime | Educational material publication date |
| presentationDate | I | 0..1 | dateTime | Educational material presentation date |
| programEligibility | I | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example) |
| fundingSource | I | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example) |
| reaction | I | 0..* | BackboneElement | Details of a reaction that follows immunization |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| date | I | 0..1 | dateTime | When reaction started |
| detail | I | 0..1 | Reference(UK Core Observation) | Additional information on reaction |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| reported | I | 0..1 | boolean | Indicates self-reported reaction |
 protocolApplied | I | 0..* | BackboneElement | Protocol followed by the provider |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| series | I | 0..1 | string | Name of vaccine series |
| authority | I | 0..1 | Reference(UK Core Organization) | Who is responsible for publishing the recommendations |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| targetDisease | I | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example) |
| doseNumber[x] | I | 1..1 | Dose number within series | |
| doseNumberPositiveInt | positiveInt | |||
| doseNumberString | string | |||
| seriesDoses[x] | I | 0..1 | Recommended number of doses for immunity | |
| seriesDosesPositiveInt | positiveInt | |||
| seriesDosesString | string | |||
| Documentation for this format | ||||
This structure is derived from Immunization
Summary
Mandatory: 0 element (3 nested mandatory elements)
Fixed Value: 1 element
Structures
This structure refers to these other structures:
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Organization
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Patient
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Encounter
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Location
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Practitioner
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Condition
- https://fhir.nhs.uk/R4/StructureDefinition/UKCore-Observation
Slices
This structure defines the following Slices:
- The element Immunization.route.coding is sliced based on the value of value:system
Differential View
This structure is derived from Immunization
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization | I | 0..* | Immunization | Immunization event information |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | I | 0..* | Identifier | Business identifier |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| status | ?!ΣI | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required) |
| statusReason | I | 0..1 | CodeableConcept | Reason not done Binding: UK Core Reason Immunization Not Administered (extensible) |
| vaccineCode | ΣI | 1..1 | CodeableConcept | Vaccine product administered Binding: UK Core Vaccine Code (extensible) |
| patient | ΣI | 1..1 | Reference(UK Core Patient) | Who was immunized |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| encounter | I | 0..1 | Reference(UK Core Encounter) | Encounter immunization was part of |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| occurrence[x] | ΣI | 1..1 | Vaccine administration date | |
| occurrenceDateTime | dateTime | |||
| occurrenceString | string | |||
| recorded | I | 0..1 | dateTime | When the immunization was first captured in the subject's record |
| primarySource | ΣI | 0..1 | boolean | Indicates context the data was recorded in |
| reportOrigin | I | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example) |
| location | I | 0..1 | Reference(UK Core Location) | Where immunization occurred |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| manufacturer | I | 0..1 | Reference(UK Core Organization) | Vaccine manufacturer |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| lotNumber | I | 0..1 | string | Vaccine lot number |
| expirationDate | I | 0..1 | date | Vaccine expiration date |
| site | I | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example) |
| route | I | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| coding | ΣI | 0..* | (Slice Definition) | Code defined by a terminology system Slice: Unordered, Open by value:system |
| coding:snomedCT | ΣI | 0..* | Coding | Code defined by a terminology system Binding: UK Core Medication Dosage Route (extensible) |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| system | ΣI | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct |
| version | ΣI | 0..1 | string | Version of the system - if relevant |
| code | ΣI | 1..1 | code | Symbol in syntax defined by the system |
| display | ΣI | 1..1 | string | Representation defined by the system |
| userSelected | ΣI | 0..1 | boolean | If this coding was chosen directly by the user |
| text | ΣI | 0..1 | string | Plain text representation of the concept |
| doseQuantity | I | 0..1 | SimpleQuantity | Amount of vaccine administered |
| performer | ΣI | 0..* | BackboneElement | Who performed event |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| function | ΣI | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible) |
| actor | ΣI | 1..1 | Reference(UK Core Practitioner | UK Core PractitionerRole | UK Core Organization) | Individual or organization who was performing |
| note | ΣI | 0..* | Annotation | Additional immunization notes |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| author[x] | ΣI | 0..1 | Individual responsible for the annotation | |
| authorReference | Reference(UK Core Practitioner | UK Core Patient | UK Core RelatedPerson | UK Core Organization) | |||
| authorString | string | |||
| time | ΣI | 0..1 | dateTime | When the annotation was made |
| text | ΣI | 1..1 | markdown | The annotation - text content (as markdown) |
| reasonCode | I | 0..* | CodeableConcept | Why immunization occurred Binding: UK Core Immunization Explanation Reason (extensible) |
| reasonReference | I | 0..* | Reference(UK Core Condition | UK Core Observation | UKCore DiagnosticReport) | Why immunization occurred |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| isSubpotent | ?!ΣI | 0..1 | boolean | Dose potency |
| subpotentReason | I | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example) |
| education | I | 0..* | BackboneElement | Educational material presented to patient imm-1: One of documentType or reference SHALL be present |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| documentType | I | 0..1 | string | Educational material document identifier |
| reference | I | 0..1 | uri | Educational material reference pointer |
| publicationDate | I | 0..1 | dateTime | Educational material publication date |
| presentationDate | I | 0..1 | dateTime | Educational material presentation date |
| programEligibility | I | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example) |
| fundingSource | I | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example) |
| reaction | I | 0..* | BackboneElement | Details of a reaction that follows immunization |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| date | I | 0..1 | dateTime | When reaction started |
| detail | I | 0..1 | Reference(UK Core Observation) | Additional information on reaction |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| reported | I | 0..1 | boolean | Indicates self-reported reaction |
| protocolApplied | I | 0..* | BackboneElement | Protocol followed by the provider |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| series | I | 0..1 | string | Name of vaccine series |
| authority | I | 0..1 | Reference(UK Core Organization) | Who is responsible for publishing the recommendations |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | ΣI | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | ΣI | 0..1 | Identifier | Logical reference, when literal reference is not known |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| use | ?!ΣI | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | ΣI | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | ΣI | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
| value | ΣI | 0..1 | string | The value that is unique Example General: 123456 |
| period | ΣI | 0..1 | Period | Time period when id is/was valid for use |
| assigner | ΣI | 0..1 | Reference(UK Core Organization) | Organization that issued id (may be just text) |
| display | ΣI | 0..1 | string | Text alternative for the resource |
| targetDisease | I | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example) |
| doseNumber[x] | I | 1..1 | Dose number within series | |
| doseNumberPositiveInt | positiveInt | |||
| doseNumberString | string | |||
| seriesDoses[x] | I | 0..1 | Recommended number of doses for immunity | |
| seriesDosesPositiveInt | positiveInt | |||
| seriesDosesString | string | |||
| Documentation for this format | ||||
Other representations of profile: Schematron
Terminology Bindings
Terminology Bindings
| Path | Conformance | ValueSet |
| Immunization.language | preferred | CommonLanguages Max Binding: AllLanguages |
| Immunization.identifier.use | required | IdentifierUse |
| Immunization.identifier.type | extensible | Identifier Type Codes |
| Immunization.status | required | ImmunizationStatusCodes |
| Immunization.statusReason | extensible | UKCoreReasonImmunizationNotAdministered |
| Immunization.vaccineCode | extensible | UKCoreVaccineCode |
| Immunization.patient.type | extensible | ResourceType |
| Immunization.patient.identifier.use | required | IdentifierUse |
| Immunization.patient.identifier.type | extensible | Identifier Type Codes |
| Immunization.encounter.type | extensible | ResourceType |
| Immunization.encounter.identifier.use | required | IdentifierUse |
| Immunization.encounter.identifier.type | extensible | Identifier Type Codes |
| Immunization.reportOrigin | example | ImmunizationOriginCodes |
| Immunization.location.type | extensible | ResourceType |
| Immunization.location.identifier.use | required | IdentifierUse |
| Immunization.location.identifier.type | extensible | Identifier Type Codes |
| Immunization.manufacturer.type | extensible | ResourceType |
| Immunization.manufacturer.identifier.use | required | IdentifierUse |
| Immunization.manufacturer.identifier.type | extensible | Identifier Type Codes |
| Immunization.site | example | CodesForImmunizationSiteOfAdministration |
| Immunization.route | example | ImmunizationRouteCodes |
| Immunization.route.coding:snomedCT | extensible | UKCoreMedicationDosageRoute |
| Immunization.performer.function | extensible | ImmunizationFunctionCodes |
| Immunization.reasonCode | extensible | UKCoreImmunizationExplanationReason |
| Immunization.reasonReference.type | extensible | ResourceType |
| Immunization.reasonReference.identifier.use | required | IdentifierUse |
| Immunization.reasonReference.identifier.type | extensible | Identifier Type Codes |
| Immunization.subpotentReason | example | ImmunizationSubpotentReason |
| Immunization.programEligibility | example | ImmunizationProgramEligibility |
| Immunization.fundingSource | example | ImmunizationFundingSource |
| Immunization.reaction.detail.type | extensible | ResourceType |
| Immunization.reaction.detail.identifier.use | required | IdentifierUse |
| Immunization.reaction.detail.identifier.type | extensible | Identifier Type Codes |
| Immunization.protocolApplied.authority.type | extensible | ResourceType |
| Immunization.protocolApplied.authority.identifier.use | required | IdentifierUse |
| Immunization.protocolApplied.authority.identifier.type | extensible | Identifier Type Codes |
| Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes |
Constraints
Constraints
| Id | Path | Details | Requirements |
| dom-2 | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | Immunization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | Immunization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | Immunization.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.statusReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.vaccineCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.patient.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.patient.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.patient.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.patient.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.patient.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.patient.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.patient.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.patient.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.patient.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.patient.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.patient.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.patient.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.patient.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.patient.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.encounter | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.encounter.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.encounter.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.encounter.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.encounter.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.encounter.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.encounter.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.encounter.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.encounter.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.encounter.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.encounter.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.encounter.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.encounter.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.encounter.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.encounter.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.occurrence[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.recorded | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.primarySource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reportOrigin | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.location.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.location.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.location.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.location.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.location.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.location.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.location.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.location.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.location.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.location.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.location.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.location.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.location.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.location.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.manufacturer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.manufacturer.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.manufacturer.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.manufacturer.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.manufacturer.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.manufacturer.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.manufacturer.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.manufacturer.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.manufacturer.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.manufacturer.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.manufacturer.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.manufacturer.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.manufacturer.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.manufacturer.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.manufacturer.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.lotNumber | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.expirationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.site | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.route | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.route.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.route.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.route.coding | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.route.coding:snomedCT | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.route.coding:snomedCT.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.route.coding:snomedCT.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.route.coding:snomedCT.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.route.coding:snomedCT.version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.route.coding:snomedCT.code | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.route.coding:snomedCT.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.route.coding:snomedCT.userSelected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.route.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.doseQuantity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.performer | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.performer.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.performer.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.performer.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.performer.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.performer.function | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.performer.actor | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.note | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.note.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.note.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.note.author[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.note.time | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.note.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reasonReference.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.reasonReference.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.reasonReference.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reasonReference.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reasonReference.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reasonReference.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.reasonReference.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.reasonReference.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reasonReference.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reasonReference.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reasonReference.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reasonReference.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reasonReference.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reasonReference.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.isSubpotent | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.subpotentReason | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.education | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| imm-1 | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() | |
| ele-1 | Immunization.education.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.education.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.education.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.education.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.education.documentType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.education.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.education.publicationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.education.presentationDate | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.programEligibility | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.fundingSource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reaction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reaction.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.reaction.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.reaction.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.reaction.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.reaction.date | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reaction.detail | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reaction.detail.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.reaction.detail.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.reaction.detail.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reaction.detail.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reaction.detail.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reaction.detail.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.reaction.detail.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.reaction.detail.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reaction.detail.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reaction.detail.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reaction.detail.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reaction.detail.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reaction.detail.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reaction.detail.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.reaction.reported | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.protocolApplied.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.protocolApplied.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.protocolApplied.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.protocolApplied.series | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.authority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.authority.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.protocolApplied.authority.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.protocolApplied.authority.reference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.authority.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.authority.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.authority.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | Immunization.protocolApplied.authority.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | Immunization.protocolApplied.authority.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.authority.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.authority.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.authority.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.authority.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.authority.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.authority.display | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.targetDisease | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.doseNumber[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | Immunization.protocolApplied.seriesDoses[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |