Extensions for Using Data Elements from FHIR R4 in FHIR R4B
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4 in FHIR R4B - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4_ImmunizationEvaluation_R4B

Official URL: http://hl7.org/fhir/4.0/StructureDefinition/profile-ImmunizationEvaluation Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R4_ImmunizationEvaluation_R4B

This cross-version profile allows R4 ImmunizationEvaluation content to be represented via FHIR R4B ImmunizationEvaluation resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationEvaluation 0..* ImmunizationEvaluation(4.3.0) Immunization evaluation information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!Σ 1..1 code completed | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.
... targetDisease Σ 1..1 CodeableConcept Evaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being evaluated against.
... immunizationEvent Σ 1..1 Reference(Immunization) Immunization being evaluated
... doseStatus Σ 1..1 CodeableConcept Status of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (example): The status of the administered dose relative to the published recommendations for the target disease.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationEvaluation.​status Base required Immunization Evaluation Status Codes 📍4.3.0 FHIR Std.
ImmunizationEvaluation.​targetDisease Base example Immunization Evaluation Target Disease Codes 📍4.3.0 FHIR Std.
ImmunizationEvaluation.​doseStatus Base example Immunization Evaluation Dose Status codes 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImmunizationEvaluation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImmunizationEvaluation 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImmunizationEvaluation 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 ImmunizationEvaluation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImmunizationEvaluation A resource should have narrative for robust management text.`div`.exists()
ele-1 error ImmunizationEvaluation.implicitRules, ImmunizationEvaluation.modifierExtension, ImmunizationEvaluation.status, ImmunizationEvaluation.patient, ImmunizationEvaluation.targetDisease, ImmunizationEvaluation.immunizationEvent, ImmunizationEvaluation.doseStatus All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImmunizationEvaluation.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ImmunizationEvaluation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationEvaluation 0..* ImmunizationEvaluation(4.3.0) Immunization evaluation information

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationEvaluation 0..* ImmunizationEvaluation(4.3.0) Immunization evaluation information
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier 0..* Identifier Business identifier
... status ?!Σ 1..1 code completed | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.
... patient Σ 1..1 Reference(Patient) Who this evaluation is for
... date 0..1 dateTime Date evaluation was performed
... authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
... targetDisease Σ 1..1 CodeableConcept Evaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being evaluated against.
... immunizationEvent Σ 1..1 Reference(Immunization) Immunization being evaluated
... doseStatus Σ 1..1 CodeableConcept Status of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (example): The status of the administered dose relative to the published recommendations for the target disease.
... doseStatusReason 0..* CodeableConcept Reason for the dose status
Binding: ImmunizationEvaluationDoseStatusReasonCodes (example): The reason the dose status was assigned.
... description 0..1 string Evaluation notes
... series 0..1 string Name of vaccine series
... doseNumber[x] 0..1 Dose number within series
.... doseNumberPositiveInt positiveInt
.... doseNumberString string
... seriesDoses[x] 0..1 Recommended number of doses for immunity
.... seriesDosesPositiveInt positiveInt
.... seriesDosesString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationEvaluation.​language Base preferred Common Languages 📍4.3.0 FHIR Std.
ImmunizationEvaluation.​status Base required Immunization Evaluation Status Codes 📍4.3.0 FHIR Std.
ImmunizationEvaluation.​targetDisease Base example Immunization Evaluation Target Disease Codes 📍4.3.0 FHIR Std.
ImmunizationEvaluation.​doseStatus Base example Immunization Evaluation Dose Status codes 📍4.3.0 FHIR Std.
ImmunizationEvaluation.​doseStatusReason Base example Immunization Evaluation Dose Status Reason codes 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImmunizationEvaluation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImmunizationEvaluation 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImmunizationEvaluation 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 ImmunizationEvaluation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImmunizationEvaluation A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning ImmunizationEvaluation.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error ImmunizationEvaluation.meta, ImmunizationEvaluation.implicitRules, ImmunizationEvaluation.language, ImmunizationEvaluation.text, ImmunizationEvaluation.extension, ImmunizationEvaluation.modifierExtension, ImmunizationEvaluation.identifier, ImmunizationEvaluation.status, ImmunizationEvaluation.patient, ImmunizationEvaluation.date, ImmunizationEvaluation.authority, ImmunizationEvaluation.targetDisease, ImmunizationEvaluation.immunizationEvent, ImmunizationEvaluation.doseStatus, ImmunizationEvaluation.doseStatusReason, ImmunizationEvaluation.description, ImmunizationEvaluation.series, ImmunizationEvaluation.doseNumber[x], ImmunizationEvaluation.seriesDoses[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImmunizationEvaluation.extension, ImmunizationEvaluation.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ImmunizationEvaluation

Summary

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationEvaluation 0..* ImmunizationEvaluation(4.3.0) Immunization evaluation information
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... status ?!Σ 1..1 code completed | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.
... targetDisease Σ 1..1 CodeableConcept Evaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being evaluated against.
... immunizationEvent Σ 1..1 Reference(Immunization) Immunization being evaluated
... doseStatus Σ 1..1 CodeableConcept Status of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (example): The status of the administered dose relative to the published recommendations for the target disease.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationEvaluation.​status Base required Immunization Evaluation Status Codes 📍4.3.0 FHIR Std.
ImmunizationEvaluation.​targetDisease Base example Immunization Evaluation Target Disease Codes 📍4.3.0 FHIR Std.
ImmunizationEvaluation.​doseStatus Base example Immunization Evaluation Dose Status codes 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImmunizationEvaluation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImmunizationEvaluation 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImmunizationEvaluation 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 ImmunizationEvaluation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImmunizationEvaluation A resource should have narrative for robust management text.`div`.exists()
ele-1 error ImmunizationEvaluation.implicitRules, ImmunizationEvaluation.modifierExtension, ImmunizationEvaluation.status, ImmunizationEvaluation.patient, ImmunizationEvaluation.targetDisease, ImmunizationEvaluation.immunizationEvent, ImmunizationEvaluation.doseStatus All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImmunizationEvaluation.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from ImmunizationEvaluation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationEvaluation 0..* ImmunizationEvaluation(4.3.0) Immunization evaluation information

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationEvaluation 0..* ImmunizationEvaluation(4.3.0) Immunization evaluation information
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
Constraints: dom-r4b
... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... identifier 0..* Identifier Business identifier
... status ?!Σ 1..1 code completed | entered-in-error
Binding: ImmunizationEvaluationStatusCodes (required): The status of the evaluation being done.
... patient Σ 1..1 Reference(Patient) Who this evaluation is for
... date 0..1 dateTime Date evaluation was performed
... authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
... targetDisease Σ 1..1 CodeableConcept Evaluation target disease
Binding: ImmunizationEvaluationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being evaluated against.
... immunizationEvent Σ 1..1 Reference(Immunization) Immunization being evaluated
... doseStatus Σ 1..1 CodeableConcept Status of the dose relative to published recommendations
Binding: ImmunizationEvaluationDoseStatusCodes (example): The status of the administered dose relative to the published recommendations for the target disease.
... doseStatusReason 0..* CodeableConcept Reason for the dose status
Binding: ImmunizationEvaluationDoseStatusReasonCodes (example): The reason the dose status was assigned.
... description 0..1 string Evaluation notes
... series 0..1 string Name of vaccine series
... doseNumber[x] 0..1 Dose number within series
.... doseNumberPositiveInt positiveInt
.... doseNumberString string
... seriesDoses[x] 0..1 Recommended number of doses for immunity
.... seriesDosesPositiveInt positiveInt
.... seriesDosesString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationEvaluation.​language Base preferred Common Languages 📍4.3.0 FHIR Std.
ImmunizationEvaluation.​status Base required Immunization Evaluation Status Codes 📍4.3.0 FHIR Std.
ImmunizationEvaluation.​targetDisease Base example Immunization Evaluation Target Disease Codes 📍4.3.0 FHIR Std.
ImmunizationEvaluation.​doseStatus Base example Immunization Evaluation Dose Status codes 📍4.3.0 FHIR Std.
ImmunizationEvaluation.​doseStatusReason Base example Immunization Evaluation Dose Status Reason codes 📍4.3.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImmunizationEvaluation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImmunizationEvaluation 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.exists() and ('#'+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(uri) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ImmunizationEvaluation 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 ImmunizationEvaluation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImmunizationEvaluation A resource should have narrative for robust management text.`div`.exists()
dom-r4b warning ImmunizationEvaluation.contained Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems ($this is Citation or $this is Evidence or $this is EvidenceReport or $this is EvidenceVariable or $this is MedicinalProductDefinition or $this is PackagedProductDefinition or $this is AdministrableProductDefinition or $this is Ingredient or $this is ClinicalUseDefinition or $this is RegulatedAuthorization or $this is SubstanceDefinition or $this is SubscriptionStatus or $this is SubscriptionTopic) implies (%resource is Citation or %resource is Evidence or %resource is EvidenceReport or %resource is EvidenceVariable or %resource is MedicinalProductDefinition or %resource is PackagedProductDefinition or %resource is AdministrableProductDefinition or %resource is Ingredient or %resource is ClinicalUseDefinition or %resource is RegulatedAuthorization or %resource is SubstanceDefinition or %resource is SubscriptionStatus or %resource is SubscriptionTopic)
ele-1 error ImmunizationEvaluation.meta, ImmunizationEvaluation.implicitRules, ImmunizationEvaluation.language, ImmunizationEvaluation.text, ImmunizationEvaluation.extension, ImmunizationEvaluation.modifierExtension, ImmunizationEvaluation.identifier, ImmunizationEvaluation.status, ImmunizationEvaluation.patient, ImmunizationEvaluation.date, ImmunizationEvaluation.authority, ImmunizationEvaluation.targetDisease, ImmunizationEvaluation.immunizationEvent, ImmunizationEvaluation.doseStatus, ImmunizationEvaluation.doseStatusReason, ImmunizationEvaluation.description, ImmunizationEvaluation.series, ImmunizationEvaluation.doseNumber[x], ImmunizationEvaluation.seriesDoses[x] All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ImmunizationEvaluation.extension, ImmunizationEvaluation.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ImmunizationEvaluation

Summary

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron