QI-Core Implementation Guide
6.0.0 - STU6
QI-Core Implementation Guide
6.0.0 - STU6
This page is part of the Quality Improvement Core Framework (v6.0.0: STU6 (v6.0.0)) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunization | Version: 6.0.0 | |||
| Active as of 2018-08-22 | Computable Name: QICoreImmunization | |||
Profile of Immunization for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.
The following example illustrates the use of the Immunization profile:
define "Polio Immunizations":
["Immunization": "Inactivated Polio Vaccine (IPV)"] PolioVaccination
where PolioVaccination.status = 'completed'
| Example of Influenza immunization shot |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USCoreImmunizationProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Immunization | USCoreImmunizationProfile | |||
  id | 0..1 | id | Logical id of this artifact | |
| status | 1..1 | code | (QI-Core)(USCDI) completed | entered-in-error Binding: Non-Negative Immunization Status (required) | |
| statusReason | 0..1 | CodeableConcept | (QI-Core)(USCDI) Reason not done Binding: ImmunizationStatusReasonCodes (preferred) | |
 patient | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) Who was immunized | |
 recorded | 0..1 | dateTime | (QI-Core) When the immunization was first captured in the subject's record | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Immunization.status | required | NonNegativeImmunizationStatushttp://hl7.org/fhir/us/qicore/ValueSet/qicore-non-negative-immunization-statusfrom this IG | |
| Immunization.statusReason | preferred | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reasonfrom the FHIR Standard |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization | C | 0..* | USCoreImmunizationProfile | Immunization event information us-core-5: SHOULD have a translation to the NDC value set |
 id | Σ | 0..1 | id | Logical id of this artifact |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | (QI-Core)(USCDI) completed | entered-in-error Binding: Non-Negative Immunization Status (required) |
 statusReason | S | 0..1 | CodeableConcept | (QI-Core)(USCDI) Reason not done Binding: ImmunizationStatusReasonCodes (preferred) |
| vaccineCode | SΣC | 1..1 | CodeableConcept | (USCDI) Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set  (extensible) |
| patient | SΣ | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) Who was immunized |
  occurrence[x] | SΣ | 1..1 | (USCDI) Vaccine administration date | |
 occurrenceDateTime | dateTime | |||
| recorded | 0..1 | dateTime | (QI-Core) When the immunization was first captured in the subject's record | |
| primarySource | SΣ | 0..1 | boolean | (USCDI) Indicates context the data was recorded in |
| isSubpotent | ?!Σ | 0..1 | boolean | Dose potency |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Immunization.status | required | NonNegativeImmunizationStatushttp://hl7.org/fhir/us/qicore/ValueSet/qicore-non-negative-immunization-statusfrom this IG | |
| Immunization.statusReason | preferred | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reasonfrom the FHIR Standard | |
| Immunization.vaccineCode | extensible | CVX Vaccines Administered Vaccine Set http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-5 | best practice | Immunization | SHOULD have a translation to the NDC value set : vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').empty() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization | C | 0..* | USCoreImmunizationProfile | Immunization event information us-core-5: SHOULD have a translation to the NDC value set | ||||
| id | Σ | 0..1 | id | 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 | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | Business identifier | |||||
| status | ?!SΣ | 1..1 | code | (QI-Core)(USCDI) completed | entered-in-error Binding: Non-Negative Immunization Status (required) | ||||
| statusReason | S | 0..1 | CodeableConcept | (QI-Core)(USCDI) Reason not done Binding: ImmunizationStatusReasonCodes (preferred) | ||||
| vaccineCode | SΣC | 1..1 | CodeableConcept | (USCDI) Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set (extensible) | ||||
| patient | SΣ | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) Who was immunized | ||||
| encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| occurrence[x] | SΣ | 1..1 | (USCDI) Vaccine administration date | |||||
| occurrenceDateTime | dateTime S | |||||||
| occurrenceString | string | |||||||
| recorded | 0..1 | dateTime | (QI-Core) When the immunization was first captured in the subject's record | |||||
| primarySource | SΣ | 0..1 | boolean | (USCDI) 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(Organization) | 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 | C | 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 | 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Immunization.status | required | NonNegativeImmunizationStatushttp://hl7.org/fhir/us/qicore/ValueSet/qicore-non-negative-immunization-statusfrom this IG | ||||
| Immunization.statusReason | preferred | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reasonfrom the FHIR Standard | ||||
| Immunization.vaccineCode | extensible | CVX Vaccines Administered Vaccine Set http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 | ||||
| Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-originfrom the FHIR Standard | ||||
| Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-sitefrom the FHIR Standard | ||||
| Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-routefrom the FHIR Standard | ||||
| Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-functionfrom the FHIR Standard | ||||
| Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reasonfrom the FHIR Standard | ||||
| Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reasonfrom the FHIR Standard | ||||
| Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibilityfrom the FHIR Standard | ||||
| Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-sourcefrom the FHIR Standard | ||||
| Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-diseasefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() | |
| us-core-5 | best practice | Immunization | SHOULD have a translation to the NDC value set : vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').empty() |
This structure is derived from USCoreImmunizationProfile
Differential View
This structure is derived from USCoreImmunizationProfile
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization | USCoreImmunizationProfile | |||
| id | 0..1 | id | Logical id of this artifact | |
| status | 1..1 | code | (QI-Core)(USCDI) completed | entered-in-error Binding: Non-Negative Immunization Status (required) | |
| statusReason | 0..1 | CodeableConcept | (QI-Core)(USCDI) Reason not done Binding: ImmunizationStatusReasonCodes (preferred) | |
| patient | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) Who was immunized | |
| recorded | 0..1 | dateTime | (QI-Core) When the immunization was first captured in the subject's record | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Immunization.status | required | NonNegativeImmunizationStatushttp://hl7.org/fhir/us/qicore/ValueSet/qicore-non-negative-immunization-statusfrom this IG | |
| Immunization.statusReason | preferred | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reasonfrom the FHIR Standard |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Immunization | C | 0..* | USCoreImmunizationProfile | Immunization event information us-core-5: SHOULD have a translation to the NDC value set |
| id | Σ | 0..1 | id | Logical id of this artifact |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!SΣ | 1..1 | code | (QI-Core)(USCDI) completed | entered-in-error Binding: Non-Negative Immunization Status (required) |
| statusReason | S | 0..1 | CodeableConcept | (QI-Core)(USCDI) Reason not done Binding: ImmunizationStatusReasonCodes (preferred) |
| vaccineCode | SΣC | 1..1 | CodeableConcept | (USCDI) Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set (extensible) |
| patient | SΣ | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) Who was immunized |
| occurrence[x] | SΣ | 1..1 | (USCDI) Vaccine administration date | |
| occurrenceDateTime | dateTime | |||
| recorded | 0..1 | dateTime | (QI-Core) When the immunization was first captured in the subject's record | |
| primarySource | SΣ | 0..1 | boolean | (USCDI) Indicates context the data was recorded in |
| isSubpotent | ?!Σ | 0..1 | boolean | Dose potency |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| Immunization.status | required | NonNegativeImmunizationStatushttp://hl7.org/fhir/us/qicore/ValueSet/qicore-non-negative-immunization-statusfrom this IG | |
| Immunization.statusReason | preferred | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reasonfrom the FHIR Standard | |
| Immunization.vaccineCode | extensible | CVX Vaccines Administered Vaccine Set http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| us-core-5 | best practice | Immunization | SHOULD have a translation to the NDC value set : vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').empty() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Immunization | C | 0..* | USCoreImmunizationProfile | Immunization event information us-core-5: SHOULD have a translation to the NDC value set | ||||
| id | Σ | 0..1 | id | 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 | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | 0..* | Identifier | Business identifier | |||||
| status | ?!SΣ | 1..1 | code | (QI-Core)(USCDI) completed | entered-in-error Binding: Non-Negative Immunization Status (required) | ||||
| statusReason | S | 0..1 | CodeableConcept | (QI-Core)(USCDI) Reason not done Binding: ImmunizationStatusReasonCodes (preferred) | ||||
| vaccineCode | SΣC | 1..1 | CodeableConcept | (USCDI) Vaccine Product Type (bind to CVX) Binding: CVX Vaccines Administered Vaccine Set (extensible) | ||||
| patient | SΣ | 1..1 | Reference(QICore Patient) | (QI-Core)(USCDI) Who was immunized | ||||
| encounter | 0..1 | Reference(Encounter) | Encounter immunization was part of | |||||
| occurrence[x] | SΣ | 1..1 | (USCDI) Vaccine administration date | |||||
| occurrenceDateTime | dateTime S | |||||||
| occurrenceString | string | |||||||
| recorded | 0..1 | dateTime | (QI-Core) When the immunization was first captured in the subject's record | |||||
| primarySource | SΣ | 0..1 | boolean | (USCDI) 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(Organization) | 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 | C | 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 | 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 | ||||||||
| Path | Conformance | ValueSet | URI | |||
| Immunization.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Immunization.status | required | NonNegativeImmunizationStatushttp://hl7.org/fhir/us/qicore/ValueSet/qicore-non-negative-immunization-statusfrom this IG | ||||
| Immunization.statusReason | preferred | ImmunizationStatusReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-status-reasonfrom the FHIR Standard | ||||
| Immunization.vaccineCode | extensible | CVX Vaccines Administered Vaccine Set http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1010.6 | ||||
| Immunization.reportOrigin | example | ImmunizationOriginCodeshttp://hl7.org/fhir/ValueSet/immunization-originfrom the FHIR Standard | ||||
| Immunization.site | example | CodesForImmunizationSiteOfAdministrationhttp://hl7.org/fhir/ValueSet/immunization-sitefrom the FHIR Standard | ||||
| Immunization.route | example | ImmunizationRouteCodeshttp://hl7.org/fhir/ValueSet/immunization-routefrom the FHIR Standard | ||||
| Immunization.performer.function | extensible | ImmunizationFunctionCodeshttp://hl7.org/fhir/ValueSet/immunization-functionfrom the FHIR Standard | ||||
| Immunization.reasonCode | example | ImmunizationReasonCodeshttp://hl7.org/fhir/ValueSet/immunization-reasonfrom the FHIR Standard | ||||
| Immunization.subpotentReason | example | ImmunizationSubpotentReasonhttp://hl7.org/fhir/ValueSet/immunization-subpotent-reasonfrom the FHIR Standard | ||||
| Immunization.programEligibility | example | ImmunizationProgramEligibilityhttp://hl7.org/fhir/ValueSet/immunization-program-eligibilityfrom the FHIR Standard | ||||
| Immunization.fundingSource | example | ImmunizationFundingSourcehttp://hl7.org/fhir/ValueSet/immunization-funding-sourcefrom the FHIR Standard | ||||
| Immunization.protocolApplied.targetDisease | example | ImmunizationTargetDiseaseCodeshttp://hl7.org/fhir/ValueSet/immunization-target-diseasefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Immunization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | 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 | error | 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 | error | Immunization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Immunization | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| imm-1 | error | Immunization.education | One of documentType or reference SHALL be present : documentType.exists() or reference.exists() | |
| us-core-5 | best practice | Immunization | SHOULD have a translation to the NDC value set : vaccineCode.coding.where(system='http://hl7.org/fhir/sid/ndc').empty() |
This structure is derived from USCoreImmunizationProfile
Other representations of profile: CSV, Excel, Schematron
IG © 2019+ HL7 International / Clinical Quality Information. Package hl7.fhir.us.qicore#6.0.0 based on FHIR 4.0.1. Generated 2024-03-01
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change