Left: | QICoreImmunization (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunization) |
Right: | QICoreImmunization (http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunization) |
Error | StructureDefinition.version | Values for version differ: '4.1.0' vs '4.1.1' |
Error | Immunization.patient | Type Mismatch: Reference([CanonicalType[http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient]]) vs Reference([CanonicalType[http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient]]) |
Error | Immunization.encounter | Type Mismatch: Reference([CanonicalType[http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-encounter]]) vs Reference([CanonicalType[http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-encounter]]) |
Error | Immunization.location | Type Mismatch: Reference([CanonicalType[http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-location]]) vs Reference([CanonicalType[http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-location]]) |
Error | Immunization.manufacturer | Type Mismatch: Reference([CanonicalType[http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization]]) vs Reference([CanonicalType[http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization]]) |
Error | Immunization.reaction.detail | Type Mismatch: Reference([CanonicalType[http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-observation]]) vs Reference([CanonicalType[http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-observation]]) |
Error | Immunization.protocolApplied.authority | Type Mismatch: Reference([CanonicalType[http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization]]) vs Reference([CanonicalType[http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization]]) |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization | ||
copyright | |||
date | 2018-08-22 | ||
description | Profile of Immunization for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors. | ||
experimental | false | ||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | resource | ||
name | QICoreImmunization | ||
publisher | http://www.hl7.org/Special/committees/cqi/index.cfm | ||
purpose | |||
status | draft | ||
title | |||
type | Immunization | ||
url | http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunization | ||
version | 4.1.0 | 4.1.1 |
|
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) Max Binding: AllLanguages: A human language. | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: 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 | |||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||
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: US Core Vaccine Administered Value Set (CVX) (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 | |
patient | SΣ | 1..1 | Reference(QICorePatient) | Who was immunized | SΣ | 1..1 | Reference(QICorePatient) | Who was immunized |
|
encounter | 0..1 | Reference(QICoreEncounter) | Encounter immunization was part of | 0..1 | Reference(QICoreEncounter) | Encounter immunization was part of |
| ||
occurrence[x] | SΣ | 1..1 | dateTime | Vaccine administration date | SΣ | 1..1 | dateTime | Vaccine administration date | |
recorded | S | 1..1 | dateTime | When the immunization was first captured in the subject's record | S | 1..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(QICoreLocation) | Where immunization occurred | 0..1 | Reference(QICoreLocation) | Where immunization occurred |
| ||
manufacturer | 0..1 | Reference(QICoreOrganization) | Vaccine manufacturer | 0..1 | Reference(QICoreOrganization) | 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(QICoreObservation) | Additional information on reaction | 0..1 | Reference(QICoreObservation) | 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(QICoreOrganization) | Who is responsible for publishing the recommendations | 0..1 | Reference(QICoreOrganization) | 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 |