Left: | COVID-19 Immunization (http://hl7.org/fhir/us/covid19library/StructureDefinition/covid-19-immunization) |
Right: | COVID-19 Immunization (http://hl7.org/fhir/us/covid19library/StructureDefinition/covid-19-immunization) |
Error | StructureDefinition.version | Values for version differ: '0.14.0' vs '1.0.0' |
Information | StructureDefinition.date | Values for date differ: '2021-12-08T02:47:19+00:00' vs '2022-07-25T13:21:55+00:00' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | ||
copyright | HL7 International & Logica Health, all rights reserved Creative Commons License | ||
date | 2021-12-08T02:47:19+00:00 | 2022-07-25T13:21:55+00:00 |
|
description | A profile of the Immunization resource, constrainind some elements to specific to SARS CoV 2 information. | A profile of the Immunization resource, constraining some elements to specific to SARS CoV 2 information. |
|
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | resource | ||
name | COVID19Immunization | ||
publisher | HL7 International - Clinical Information Modeling Initiative | ||
purpose | |||
status | active | ||
title | COVID-19 Immunization | ||
type | Immunization | ||
url | http://hl7.org/fhir/us/covid19library/StructureDefinition/covid-19-immunization | ||
version | 0.14.0 | 1.0.0 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Immunization | 0..* | USCoreImmunizationProfile | Immunization event information | 0..* | USCoreImmunizationProfile | Immunization event information | |||||||||||
id | Σ | 0..1 | string | Logical id of this artifact | Σ | 0..1 | string | Logical id of this artifact | |||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 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.
| 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 | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
identifier | 0..* | Identifier | Business identifier | 0..* | Identifier | Business identifier | |||||||||||
status | ?!SΣ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): Constrained list of immunizaiotn 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) | S | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example) | |||||||||
vaccineCode | SΣI | 1..1 | CodeableConcept | Vaccine Product Type (bind to CVX) Binding: USCoreVaccineAdministeredValueSetCvx (extensible): The CVX (vaccine administered) code system us-core-1: SHOULD have a translation to the NDC value set | 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 | 0..1 | string | Unique id for inter-element referencing | |||||||||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | Σ | 0..* | Coding | Code defined by a terminology system | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
system | Σ | 0..1 | uri | Identity of the terminology system | Σ | 0..1 | uri | Identity of the terminology system | |||||||||
version | Σ | 0..1 | string | Version of the system - if relevant | Σ | 0..1 | string | Version of the system - if relevant | |||||||||
code | Σ | 0..1 | code | Symbol in syntax defined by the system Binding: COVID19_CVX_CodesVS (extensible) | Σ | 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 | Σ | 0..1 | string | Representation defined by the system | |||||||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | Σ | 0..1 | boolean | If this coding was chosen directly by the user | |||||||||
text | Σ | 0..1 | string | Plain text representation of the concept | Σ | 0..1 | string | Plain text representation of the concept | |||||||||
patient | SΣ | 1..1 | Reference(US Core Patient Profile) | Who was immunized | SΣ | 1..1 | Reference(US Core Patient Profile) | Who was immunized | |||||||||
encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||||||||
occurrence[x] | SΣ | 1..1 | dateTime, string | Vaccine administration date | SΣ | 1..1 | dateTime, string | Vaccine administration date | |||||||||
recorded | 0..1 | dateTime | When the immunization was first captured in the subject's record | 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 | 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. | 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 | 0..1 | Reference(Location) | Where immunization occurred | |||||||||||
manufacturer | 0..1 | Reference(COVID 19 Vaccine Manufacturer) | Vaccine manufacturer | 0..1 | Reference(COVID 19 Vaccine Manufacturer) | Vaccine manufacturer | |||||||||||
lotNumber | 0..1 | string | Vaccine lot number | 0..1 | string | Vaccine lot number | |||||||||||
expirationDate | 0..1 | date | Vaccine expiration date | 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. | 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. | 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 | 0..1 | SimpleQuantity | Amount of vaccine administered | |||||||||||
performer | Σ | 0..* | BackboneElement | Who performed event | Σ | 0..* | BackboneElement | Who performed event | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 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. | Σ | 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 | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | |||||||||
note | Σ | 0..* | Annotation | Additional immunization notes | Σ | 0..* | Annotation | Additional immunization notes | |||||||||
reasonCode | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | 0..* | CodeableConcept | Why immunization occurred Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | |||||||||||
reasonReference | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | |||||||||||
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency | ?!Σ | 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. | 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 imm-1: One of documentType or reference SHALL be present | I | 0..* | BackboneElement | Educational material presented to patient | |||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
documentType | 0..1 | string | Educational material document identifier | 0..1 | string | Educational material document identifier | |||||||||||
reference | 0..1 | uri | Educational material reference pointer | 0..1 | uri | Educational material reference pointer | |||||||||||
publicationDate | 0..1 | dateTime | Educational material publication date | 0..1 | dateTime | Educational material publication date | |||||||||||
presentationDate | 0..1 | dateTime | Educational material presentation date | 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. | 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. | 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 | 0..* | BackboneElement | Details of a reaction that follows immunization | |||||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
date | 0..1 | dateTime | When reaction started | 0..1 | dateTime | When reaction started | |||||||||||
detail | 0..1 | Reference(Observation) | Additional information on reaction | 0..1 | Reference(Observation) | Additional information on reaction | |||||||||||
reported | 0..1 | boolean | Indicates self-reported reaction | 0..1 | boolean | Indicates self-reported reaction | |||||||||||
protocolApplied | 0..* | BackboneElement | Protocol followed by the provider | 0..* | BackboneElement | Protocol followed by the provider | |||||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
series | 0..1 | string | Name of vaccine series | 0..1 | string | Name of vaccine series | |||||||||||
authority | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | 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. | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for. | |||||||||||
doseNumber[x] | 1..1 | positiveInt, string | Dose number within series | 1..1 | positiveInt, string | Dose number within series | |||||||||||
seriesDoses[x] | 0..1 | positiveInt, string | Recommended number of doses for immunity | 0..1 | positiveInt, string | Recommended number of doses for immunity | |||||||||||
Documentation for this format |