COVID-19 FHIR Profile Library IG Informative Version, published by HL7 International - Clinical Information Modeling Initiative. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/fhir-COVID19Library-ig/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/covid19library/StructureDefinition/covid-19-immunization | Version: 1.0.0 | |||
Active as of 2022-07-25 | Computable Name: COVID19Immunization | |||
Copyright/Legal: HL7 International & Logica Health, all rights reserved Creative Commons License |
A profile of the Immunization resource, constraining some elements to specific to SARS CoV 2 information.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreImmunizationProfile
This structure is derived from USCoreImmunizationProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | 0..* | USCoreImmunizationProfile | Immunization event information | |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
procedureCode | S | 1..1 | CodeableConcept | Procedure Code URL: http://hl7.org/fhir/us/covid19library/StructureDefinition/procedure-code |
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 33879002 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Administration of vaccine to produce active immunity (procedure) | |
vaccineCode | ||||
coding | ||||
code | 0..1 | code | Symbol in syntax defined by the system Binding: COVID 19 CVX Code System Vaccine Codes (extensible) | |
manufacturer | 0..1 | Reference(COVID 19 Vaccine Manufacturer) | Vaccine manufacturer | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Immunization | 0..* | USCoreImmunizationProfile | Immunization event information | |||||
id | Σ | 0..1 | string | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
procedureCode | S | 1..1 | CodeableConcept | Procedure Code URL: http://hl7.org/fhir/us/covid19library/StructureDefinition/procedure-code | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/us/covid19library/StructureDefinition/procedure-code" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 33879002 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Administration of vaccine to produce active immunity (procedure) | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | Business identifier | |||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): Constrained list of immunizaiotn status | ||||
statusReason | S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example) | ||||
vaccineCode | SΣI | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: US Core Vaccine Administered Value Set (CVX) (extensible): The CVX (vaccine administered) code system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: COVID 19 CVX Code System Vaccine Codes (extensible) | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
patient | SΣ | 1..1 | Reference(US Core Patient Profile) | Who was immunized | ||||
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
occurrence[x] | SΣ | 1..1 | Vaccine administration date | |||||
occurrenceDateTime | dateTime | |||||||
occurrenceString | string | |||||||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
primarySource | SΣ | 1..1 | boolean | Indicates context the data was recorded in | ||||
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
location | 0..1 | Reference(Location) | Where immunization occurred | |||||
manufacturer | 0..1 | Reference(COVID 19 Vaccine Manufacturer) | Vaccine manufacturer | |||||
lotNumber | 0..1 | string | Vaccine lot number | |||||
expirationDate | 0..1 | date | Vaccine expiration date | |||||
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
route | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |||||
performer | Σ | 0..* | BackboneElement | Who performed event | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
note | Σ | 0..* | Annotation | Additional immunization notes | ||||
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
education | I | 0..* | BackboneElement | Educational material presented to patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
documentType | 0..1 | string | Educational material document identifier | |||||
reference | 0..1 | uri | Educational material reference pointer | |||||
publicationDate | 0..1 | dateTime | Educational material publication date | |||||
presentationDate | 0..1 | dateTime | Educational material presentation date | |||||
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
date | 0..1 | dateTime | When reaction started | |||||
detail | 0..1 | Reference(Observation) | Additional information on reaction | |||||
reported | 0..1 | boolean | Indicates self-reported reaction | |||||
protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
series | 0..1 | string | Name of vaccine series | |||||
authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
doseNumber[x] | 1..1 | Dose number within series | ||||||
doseNumberPositiveInt | positiveInt | |||||||
doseNumberString | string | |||||||
seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||
seriesDosesPositiveInt | positiveInt | |||||||
seriesDosesString | string | |||||||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | 0..* | USCoreImmunizationProfile | Immunization event information | |
procedureCode | 1..1 | CodeableConcept | Procedure Code URL: http://hl7.org/fhir/us/covid19library/StructureDefinition/procedure-code | |
status | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): Constrained list of immunizaiotn status |
statusReason | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example) | |
vaccineCode | ΣI | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: US Core Vaccine Administered Value Set (CVX) (extensible): The CVX (vaccine administered) code system |
patient | Σ | 1..1 | Reference(US Core Patient Profile) | Who was immunized |
occurrence[x] | Σ | 1..1 | Vaccine administration date | |
occurrenceDateTime | dateTime | |||
occurrenceString | string | |||
primarySource | Σ | 1..1 | boolean | Indicates context the data was recorded in |
Documentation for this format |
This structure is derived from USCoreImmunizationProfile
Differential View
This structure is derived from USCoreImmunizationProfile
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Immunization | 0..* | USCoreImmunizationProfile | Immunization event information | |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
procedureCode | S | 1..1 | CodeableConcept | Procedure Code URL: http://hl7.org/fhir/us/covid19library/StructureDefinition/procedure-code |
valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 33879002 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Administration of vaccine to produce active immunity (procedure) | |
vaccineCode | ||||
coding | ||||
code | 0..1 | code | Symbol in syntax defined by the system Binding: COVID 19 CVX Code System Vaccine Codes (extensible) | |
manufacturer | 0..1 | Reference(COVID 19 Vaccine Manufacturer) | Vaccine manufacturer | |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Immunization | 0..* | USCoreImmunizationProfile | Immunization event information | |||||
id | Σ | 0..1 | string | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
procedureCode | S | 1..1 | CodeableConcept | Procedure Code URL: http://hl7.org/fhir/us/covid19library/StructureDefinition/procedure-code | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..0 | |||||||
url | 1..1 | uri | "http://hl7.org/fhir/us/covid19library/StructureDefinition/procedure-code" | |||||
Slices for value[x] | 0..1 | CodeableConcept | Value of extension Slice: Unordered, Closed by type:$this | |||||
value[x]:valueCodeableConcept | 0..1 | CodeableConcept | Value of extension Required Pattern: At least the following | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://snomed.info/sct | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 33879002 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Administration of vaccine to produce active immunity (procedure) | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | 0..* | Identifier | Business identifier | |||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): Constrained list of immunizaiotn status | ||||
statusReason | S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example) | ||||
vaccineCode | SΣI | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: US Core Vaccine Administered Value Set (CVX) (extensible): The CVX (vaccine administered) code system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: COVID 19 CVX Code System Vaccine Codes (extensible) | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
patient | SΣ | 1..1 | Reference(US Core Patient Profile) | Who was immunized | ||||
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
occurrence[x] | SΣ | 1..1 | Vaccine administration date | |||||
occurrenceDateTime | dateTime | |||||||
occurrenceString | string | |||||||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | |||||
primarySource | SΣ | 1..1 | boolean | Indicates context the data was recorded in | ||||
reportOrigin | 0..1 | CodeableConcept | Indicates the source of a secondarily reported record Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source. | |||||
location | 0..1 | Reference(Location) | Where immunization occurred | |||||
manufacturer | 0..1 | Reference(COVID 19 Vaccine Manufacturer) | Vaccine manufacturer | |||||
lotNumber | 0..1 | string | Vaccine lot number | |||||
expirationDate | 0..1 | date | Vaccine expiration date | |||||
site | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | |||||
route | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | |||||
doseQuantity | 0..1 | SimpleQuantity | Amount of vaccine administered | |||||
performer | Σ | 0..* | BackboneElement | Who performed event | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||
note | Σ | 0..* | Annotation | Additional immunization notes | ||||
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ||||
subpotentReason | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | |||||
education | I | 0..* | BackboneElement | Educational material presented to patient | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
documentType | 0..1 | string | Educational material document identifier | |||||
reference | 0..1 | uri | Educational material reference pointer | |||||
publicationDate | 0..1 | dateTime | Educational material publication date | |||||
presentationDate | 0..1 | dateTime | Educational material presentation date | |||||
programEligibility | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | |||||
fundingSource | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | |||||
reaction | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
date | 0..1 | dateTime | When reaction started | |||||
detail | 0..1 | Reference(Observation) | Additional information on reaction | |||||
reported | 0..1 | boolean | Indicates self-reported reaction | |||||
protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
series | 0..1 | string | Name of vaccine series | |||||
authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | |||||
targetDisease | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||
doseNumber[x] | 1..1 | Dose number within series | ||||||
doseNumberPositiveInt | positiveInt | |||||||
doseNumberString | string | |||||||
seriesDoses[x] | 0..1 | Recommended number of doses for immunity | ||||||
seriesDosesPositiveInt | positiveInt | |||||||
seriesDosesString | string | |||||||
Documentation for this format |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Immunization.language | preferred | CommonLanguages Max Binding: AllLanguages |
Immunization.status | required | ImmunizationStatusCodes |
Immunization.statusReason | example | ImmunizationStatusReasonCodes |
Immunization.vaccineCode | extensible | USCoreVaccineAdministeredValueSetCvx |
Immunization.vaccineCode.coding.code | extensible | COVID19_CVX_CodesVS |
Immunization.reportOrigin | example | ImmunizationOriginCodes |
Immunization.site | example | CodesForImmunizationSiteOfAdministration |
Immunization.route | example | ImmunizationRouteCodes |
Immunization.performer.function | extensible | ImmunizationFunctionCodes |
Immunization.reasonCode | example | ImmunizationReasonCodes |
Immunization.subpotentReason | example | ImmunizationSubpotentReason |
Immunization.programEligibility | example | ImmunizationProgramEligibility |
Immunization.fundingSource | example | ImmunizationFundingSource |
Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodes |