This is the set of resources that conform to both Vaccination Profile - Allowable Data (http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad) and Vaccination Profile - Allowable Data (http://hl7.org/fhir/uv/shc-vaccination/StructureDefinition/shc-vaccination-ad).
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Immunization | 0..* | Immunization event information dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | ||||||
meta | SΣ | 0..1 | Meta | Metadata about the resource ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
versionId | Σ | 0..1 | id | Version specific identifier ele-1: All FHIR elements must have a @value or children | ||||
lastUpdated | Σ | 0..1 | instant | When the resource version last changed ele-1: All FHIR elements must have a @value or children | ||||
source | Σ | 0..1 | uri | Identifies where the resource comes from ele-1: All FHIR elements must have a @value or children | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to ele-1: All FHIR elements must have a @value or children | ||||
security | SΣ | 0..1 | Coding | Limited security label to convey identity level of assurance for patient referenced by this resource. Binding: ?? (required) ele-1: All FHIR elements must have a @value or children | ||||
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: ?? (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". ele-1: All FHIR elements must have a @value or children | ||||
implicitRules | ?!Σ | 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 | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
ele-1: All FHIR elements must have a @value or children | |||||
text | 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 | |||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?! | 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 | ||||
identifier | 0..* | Identifier | Business identifier ele-1: All FHIR elements must have a @value or children | |||||
status | ?!SΣ | 1..1 | code | Whether or not the vaccination was completed Binding: ?? (required): A set of codes indicating the current status of an Immunization. ele-1: All FHIR elements must have a @value or children | ||||
vaccineCode | SΣ | 1..1 | CodeableConcept | Codes identifying the vaccine product administered Binding: ?? (example) ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
coding | SΣ | 1..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children | ||||
text | Σ | 0..1 | string | Plain text representation of the concept ele-1: All FHIR elements must have a @value or children | ||||
patient | SΣ | 1..1 | Reference(Patient Profile - General - Allowable Data | #sd-shc-patient-general-ad-shc-patient-general-ad) | Who was immunized ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
reference | Σ | 1..1 | string | This SHOULD use an absolute URI like `resource:0` that will resolve within the containing Bundle. ele-1: All FHIR elements must have a @value or children | ||||
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of ele-1: All FHIR elements must have a @value or children | |||||
occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date ele-1: All FHIR elements must have a @value or children | ||||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record ele-1: All FHIR elements must have a @value or children | |||||
primarySource | Σ | 0..1 | boolean | Information in this record from person who administered vaccine? ele-1: All FHIR elements must have a @value or children | ||||
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ?? (example): The source of the data for a record which is not from a primary source. ele-1: All FHIR elements must have a @value or children | |||||
location | 0..1 | Reference(Location) | Where immunization occurred ele-1: All FHIR elements must have a @value or children | |||||
manufacturer | S | 0..1 | Reference(Organization) | Vaccine manufacturer ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
reference | Σ | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children | ||||
identifier | SΣ | 0..1 | Identifier | Only populate when vaccine type is not provided in vaccineCode ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: ?? (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: ?? (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. ele-1: All FHIR elements must have a @value or children | ||||
system | SΣC | 1..1 | uri | Code identifying vaccine manufacturer ele-1: All FHIR elements must have a @value or children shall-use-known-vaccine-manufacturer-code-system: SHALL use a known code system for identifying vaccine manufacturers Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use ele-1: All FHIR elements must have a @value or children | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) ele-1: All FHIR elements must have a @value or children | ||||
display | Σ | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children | ||||
lotNumber | SC | 0..1 | string | String representing lot number like `0123L45A` ele-1: All FHIR elements must have a @value or children vc-should-be-under-20-chars: Length SHOULD be <20 for data minimization. vc-should-not-include-string-lot: lotNumber SHOULD NOT include `Lot #`, `Lot Number`, etc. | ||||
expirationDate | 0..1 | date | Vaccine expiration date ele-1: All FHIR elements must have a @value or children | |||||
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: ?? (example): The site at which the vaccine was administered. ele-1: All FHIR elements must have a @value or children | |||||
route | 0..1 | CodeableConcept | How vaccine entered body Binding: ?? (example): The route by which the vaccine was administered. ele-1: All FHIR elements must have a @value or children | |||||
doseQuantity | 0..1 | ??, ?? | Amount of vaccine administered ele-1: All FHIR elements must have a @value or children | |||||
performer | SΣ | 0..1 | BackboneElement | Who performed event ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ?? (extensible): The role a practitioner or organization plays in the immunization event. ele-1: All FHIR elements must have a @value or children | ||||
actor | SΣ | 1..1 | Reference(Organization) | Organization which was responsible for vaccine administration. ele-1: All FHIR elements must have a @value or children | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
reference | Σ | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children | ||||
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). ele-1: All FHIR elements must have a @value or children | ||||
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children | ||||
display | SΣC | 1..1 | string | Short, human-readable text representation of the organization. ele-1: All FHIR elements must have a @value or children vc-should-be-under-30-chars: Length SHOULD be <30 for data minimization. | ||||
note | Σ | 0..* | Annotation | Additional immunization notes ele-1: All FHIR elements must have a @value or children | ||||
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ?? (example): The reason why a vaccine was administered. ele-1: All FHIR elements must have a @value or children | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred ele-1: All FHIR elements must have a @value or children | |||||
isSubpotent | ?!SΣC | 0..1 | boolean | Set to `true` if dose is subpotent; omit otherwise ele-1: All FHIR elements must have a @value or children vc-shall-be-true-if-populated-invariant: Shall be `true` if populated | ||||
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ?? (example): The reason why a dose is considered to be subpotent. ele-1: All FHIR elements must have a @value or children | |||||
education | C | 0..* | BackboneElement | Educational material presented to patient ele-1: All FHIR elements must have a @value or children imm-1: One of documentType or reference SHALL be present | ||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
documentType | 0..1 | string | Educational material document identifier ele-1: All FHIR elements must have a @value or children | |||||
reference | 0..1 | uri | Educational material reference pointer ele-1: All FHIR elements must have a @value or children | |||||
publicationDate | 0..1 | dateTime | Educational material publication date ele-1: All FHIR elements must have a @value or children | |||||
presentationDate | 0..1 | dateTime | Educational material presentation date ele-1: All FHIR elements must have a @value or children | |||||
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ?? (example): The patient's eligibility for a vaccation program. ele-1: All FHIR elements must have a @value or children | |||||
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ?? (example): The source of funding used to purchase the vaccine administered. ele-1: All FHIR elements must have a @value or children | |||||
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization ele-1: All FHIR elements must have a @value or children | |||||
extension | 0..* | Extension | Additional content defined by implementations ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
date | 0..1 | dateTime | When reaction started ele-1: All FHIR elements must have a @value or children | |||||
detail | 0..1 | Reference(Observation) | Additional information on reaction ele-1: All FHIR elements must have a @value or children | |||||
reported | 0..1 | boolean | Indicates self-reported reaction ele-1: All FHIR elements must have a @value or children | |||||
Documentation for this format |