STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

U.S. Data Access Framework (DAF) Immunization Profile vs QICore-Immunization

Messages

A series of messages from the comparison algorithm. Errors indicate that solutions cannot be interoperable across both implementation guides (or that there are structural flaws in the definition of at least one).

PathMessage
Errors Detected
(None)
Warnings about the comparison
Immunization.doseQuantityStructureDefinition U.S. Data Access Framework (DAF) Immunization Profile has a constraint that is not found in QICore-Immunization and it is uncertain whether they are compatible (not(exists(f:code)) or exists(f:system))
Immunization.doseQuantityStructureDefinition U.S. Data Access Framework (DAF) Immunization Profile has a constraint that is not found in QICore-Immunization and it is uncertain whether they are compatible (not(exists(f:comparator)))
Notes about differences (e.g. definitions)
Immunization.vaccineCodeElements differ in definition for short:
"Vaccine Product Type (bind to CVX)"
"Vaccine product administered"
Immunization.vaccineCodeElements differ in definition for definition:
"Vaccine Product Type (bind to CVX)."
"Vaccine that was administered or was to be administered."
Immunization.manufacturerElements differ in definition for definition:
"Vaccine Manufacturer."
"Name of vaccine manufacturer."
Immunization.routeExample/preferred bindings differ at Immunization.route using binding from U.S. Data Access Framework (DAF) Immunization Profile
Immunization.routeElements differ in definition for binding.description:
"This identifies the route of substance administration."
"The route by which the vaccine was administered"

Intersection

The intersection of the 2 constraint statements. This is what resource authors (either client or server) would need to conform to produce content valid against both implementation guides.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*ImmunizationImmunization event information
imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administered (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierBusiness identifier
... status ?! S∑1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... date S1..1dateTimeVaccination administration date
... vaccineCode S1..1CodeableConceptleft: Vaccine Product Type (bind to CVX); right: Vaccine product administered
Binding: Vaccine Administered Value Set (preferred)
... patient S1..1Reference(DAF-Patient)Who was immunized
... wasNotGiven ?! S1..1booleanFlag for whether immunization was given
... reported S1..1booleanIndicates a self-reported record
... performer S0..1Reference(DAF-Pract)Who administered vaccine
... requester S0..1Reference(DAF-Pract)Who ordered vaccination
... encounter S0..1Reference(DAF-Encounter)Encounter administered as part of
... manufacturer S0..1Reference(DAF-Organization)Vaccine Manufacturer
... location 0..1Reference(QICore-Location)Where vaccination occurred
... lotNumber S0..1stringVaccine lot number
... expirationDate S0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
Binding: Vaccine Administered Body Site (preferred)
... route S0..1CodeableConceptHow vaccine entered body
Binding: Medication Route FDA Value Set (preferred)
... doseQuantity S I0..1SimpleQuantityAmount of vaccine administered
qty-3: If a code for the unit is present, the system SHALL also be present
sqty-1: The comparator is not used on a SimpleQuantity
... note ∑0..*AnnotationVaccination notes
... explanation S0..1BackboneElementAdministration/non-administration reasons
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... reason S0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example)
.... reasonNotGiven S0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example)
... reaction S0..*BackboneElementDetails of a reaction that follows immunization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... date S0..1dateTimeWhen reaction started
.... detail 0..1Reference(QICore-Observation)Additional information on reaction
.... reported S0..1booleanIndicates self-reported reaction
... vaccinationProtocol S0..*BackboneElementWhat protocol was followed
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... doseSequence S1..1positiveIntDose number within series
.... description S0..1stringDetails of vaccine protocol
.... authority S0..1Reference(DAF-Organization)Who is responsible for protocol
.... series S0..1stringName of vaccine series
.... seriesDoses S0..1positiveIntRecommended number of doses for immunity
.... targetDisease S1..1CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose Target Codes (example)
.... doseStatus S1..1CodeableConceptIndicates if dose counts towards immunity
Binding: Vaccination Protocol Dose Status codes (example)
.... doseStatusReason S0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format

Union

The union of the 2 constraint statements. This is what resource authors (either client or server) would need to be able to handle to accept content valid against either implementation guides.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Immunization I0..*ImmunizationImmunization event information
imm-2: If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.
imm-1: If immunization was not administered (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present
... meta ∑0..1MetaMetadata about the resource
... implicitRules ?! ∑0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier S0..*IdentifierBusiness identifier
... status ?! S∑1..1codein-progress | on-hold | completed | entered-in-error | stopped
Binding: MedicationAdministrationStatus (required)
... date S0..1dateTimeVaccination administration date
... vaccineCode S1..1CodeableConceptleft: Vaccine Product Type (bind to CVX); right: Vaccine product administered
Binding: Vaccine Administered Value Set (preferred)
... patient S1..1Reference(#1)Who was immunized
... wasNotGiven ?! S1..1booleanFlag for whether immunization was given
... reported S1..1booleanIndicates a self-reported record
... performer S0..1Reference(#3 | DAF-Organization)Who administered vaccine
... requester S0..1Reference(#3 | DAF-Organization)Who ordered vaccination
... encounter S0..1Reference(#4)Encounter administered as part of
... manufacturer S0..1Reference(#2)Vaccine Manufacturer
... location 0..1Reference(Location)Where vaccination occurred
... lotNumber S0..1stringVaccine lot number
... expirationDate S0..1dateVaccine expiration date
... site S0..1CodeableConceptBody site vaccine was administered
Binding: Vaccine Administered Body Site (preferred)
... route S0..1CodeableConceptHow vaccine entered body
Binding: ???? (preferred)
... doseQuantity S0..1SimpleQuantityAmount of vaccine administered
... note ∑0..*AnnotationVaccination notes
... explanation S0..1BackboneElementAdministration/non-administration reasons
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... reason S0..*CodeableConceptWhy immunization occurred
Binding: Immunization Reason Codes (example)
.... reasonNotGiven S0..*CodeableConceptWhy immunization did not occur
Binding: Immunization Reasons for Not Immunizing Codes (example)
... reaction S0..*BackboneElementDetails of a reaction that follows immunization
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... date S0..1dateTimeWhen reaction started
.... detail 0..1Reference(Observation)Additional information on reaction
.... reported S0..1booleanIndicates self-reported reaction
... vaccinationProtocol S0..*BackboneElementWhat protocol was followed
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?! ∑0..*ExtensionExtensions that cannot be ignored
.... doseSequence S1..1positiveIntDose number within series
.... description S0..1stringDetails of vaccine protocol
.... authority S0..1Reference(#2)Who is responsible for protocol
.... series S0..1stringName of vaccine series
.... seriesDoses S0..1positiveIntRecommended number of doses for immunity
.... targetDisease S1..*CodeableConceptDisease immunized against
Binding: Vaccination Protocol Dose Target Codes (example)
.... doseStatus S1..1CodeableConceptIndicates if dose counts towards immunity
Binding: Vaccination Protocol Dose Status codes (example)
.... doseStatusReason S0..1CodeableConceptWhy dose does (not) count
Binding: Vaccination Protocol Dose Status Reason codes (example)

doco Documentation for this format