{
"description": "Defines constraints and extensions on the ImmunizationEvaluation resource for the minimal set of data to query and retrieve a patient's Immunization Evaluation.",
"_filename": "StructureDefinition-qicore-immunizationevaluation.json",
"package_name": "hl7.fhir.us.qicore",
"date": "2019-07-28",
"derivation": "constraint",
"publisher": "http://www.hl7.org/Special/committees/cqi/index.cfm",
"fhirVersion": "4.0.1",
"jurisdiction": [ {
"coding": [ {
"code": "US",
"system": "urn:iso:std:iso:3166"
} ]
} ],
"name": "QICoreImmunizationEvaluation",
"mapping": [ {
"uri": "http://unknown.org/Argonaut-DQ-DSTU2",
"name": "Argonaut-DQ-DSTU2",
"identity": "argonaut-dq-dstu2"
}, {
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Pattern",
"identity": "workflow"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "ImmunizationEvaluation",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": null,
"package_version": "4.1.0",
"snapshot": {
"element": [ {
"constraint": [ {
"key": "dom-2",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-3",
"human": "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",
"xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "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()"
}, {
"key": "dom-4",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-5",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"xpath": "not(exists(f:contained/*/f:meta/f:security))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "error",
"expression": "contained.meta.security.empty()"
}, {
"key": "dom-6",
"human": "A resource should have narrative for robust management",
"xpath": "exists(f:text/h:div)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"severity": "warning",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time."
} ],
"expression": "text.`div`.exists()"
} ],
"path": "ImmunizationEvaluation",
"min": 0,
"definition": "Describes a comparison of an immunization event against published recommendations to determine if the administration is \"valid\" in relation to those recommendations.",
"isModifier": false,
"short": "Immunization evaluation information",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "Event",
"identity": "workflow"
}, {
"map": "RSP_K11",
"identity": "v2"
}, {
"map": "CarePlan",
"identity": "argonaut-dq-dstu2"
} ],
"mustSupport": false,
"max": "*",
"id": "ImmunizationEvaluation",
"base": {
"max": "*",
"min": 0,
"path": "ImmunizationEvaluation"
},
"isSummary": false
}, {
"path": "ImmunizationEvaluation.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"isModifier": false,
"short": "Logical id of this artifact",
"type": [ {
"code": "http://hl7.org/fhirpath/System.String",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "string"
} ]
} ],
"max": "1",
"id": "ImmunizationEvaluation.id",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.id"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.",
"isModifier": false,
"short": "Metadata about the resource",
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "ImmunizationEvaluation.meta",
"base": {
"max": "1",
"min": 0,
"path": "Resource.meta"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.implicitRules",
"min": 0,
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "ImmunizationEvaluation.implicitRules",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"isModifier": false,
"short": "Language of the resource content",
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "preferred",
"valueSet": "http://hl7.org/fhir/ValueSet/languages",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A human language."
},
"max": "1",
"id": "ImmunizationEvaluation.language",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"base": {
"max": "1",
"min": 0,
"path": "Resource.language"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"isModifier": false,
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "ImmunizationEvaluation.text",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
},
"isSummary": false
}, {
"path": "ImmunizationEvaluation.contained",
"min": 0,
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"isModifier": false,
"short": "Contained, inline Resources",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "ImmunizationEvaluation.contained",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "ImmunizationEvaluation.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"isModifier": false,
"short": "Additional content defined by implementations",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImmunizationEvaluation.extension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.extension"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
}, {
"key": "ext-1",
"human": "Must have either extensions or value[x], not both",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "ImmunizationEvaluation.modifierExtension",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "ImmunizationEvaluation.modifierExtension",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.modifierExtension"
},
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.identifier",
"min": 0,
"definition": "A unique identifier assigned to this immunization evaluation record.",
"isModifier": false,
"short": "Business identifier",
"mapping": [ {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "CarePlan.subject",
"identity": "argonaut-dq-dstu2"
} ],
"type": [ {
"code": "Identifier"
} ],
"mustSupport": true,
"max": "*",
"id": "ImmunizationEvaluation.identifier",
"base": {
"max": "*",
"min": 0,
"path": "ImmunizationEvaluation.identifier"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.status",
"min": 1,
"definition": "Indicates the current status of the evaluation of the vaccination administration event.",
"isModifier": true,
"short": "completed | entered-in-error",
"mapping": [ {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "FiveWs.status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"mustSupport": true,
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/immunization-evaluation-status|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationEvaluationStatus"
} ],
"description": "The status of the evaluation being done."
},
"max": "1",
"id": "ImmunizationEvaluation.status",
"base": {
"max": "1",
"min": 1,
"path": "ImmunizationEvaluation.status"
},
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid).",
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.patient",
"min": 1,
"definition": "The individual for whom the evaluation is being done.",
"isModifier": false,
"short": "Who this evaluation is for",
"mapping": [ {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": "PID-3",
"identity": "v2"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient" ]
} ],
"mustSupport": true,
"max": "1",
"id": "ImmunizationEvaluation.patient",
"base": {
"max": "1",
"min": 1,
"path": "ImmunizationEvaluation.patient"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.date",
"min": 1,
"definition": "The date the evaluation of the vaccine administration event was performed.",
"isModifier": false,
"short": "Date evaluation was performed",
"mapping": [ {
"map": "Event.occurrenceDateTime",
"identity": "workflow"
}, {
"map": "FiveWs.init",
"identity": "w5"
}, {
"map": "RXA-3",
"identity": "v2"
} ],
"type": [ {
"code": "dateTime"
} ],
"mustSupport": true,
"max": "1",
"id": "ImmunizationEvaluation.date",
"base": {
"max": "1",
"min": 0,
"path": "ImmunizationEvaluation.date"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.authority",
"min": 0,
"definition": "Indicates the authority who published the protocol (e.g. ACIP).",
"isModifier": false,
"short": "Who is responsible for publishing the recommendations",
"mapping": [ {
"map": "OBX-5 : OBX-3 = ( 59779-9 )",
"identity": "v2"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization" ]
} ],
"mustSupport": false,
"max": "1",
"id": "ImmunizationEvaluation.authority",
"base": {
"max": "1",
"min": 0,
"path": "ImmunizationEvaluation.authority"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.targetDisease",
"min": 1,
"definition": "The vaccine preventable disease the dose is being evaluated against.",
"isModifier": false,
"short": "Evaluation target disease",
"mapping": [ {
"map": "OBX-5 : OBX-3 = ( 30956-7 | 38890-0 )",
"identity": "v2"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/immunization-evaluation-target-disease",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EvaluationTargetDisease"
} ],
"description": "The vaccine preventable disease the dose is being evaluated against."
},
"max": "1",
"id": "ImmunizationEvaluation.targetDisease",
"base": {
"max": "1",
"min": 1,
"path": "ImmunizationEvaluation.targetDisease"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.immunizationEvent",
"min": 1,
"definition": "The vaccine administration event being evaluated.",
"isModifier": false,
"short": "Immunization being evaluated",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunization" ]
} ],
"mustSupport": true,
"max": "1",
"id": "ImmunizationEvaluation.immunizationEvent",
"base": {
"max": "1",
"min": 1,
"path": "ImmunizationEvaluation.immunizationEvent"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.doseStatus",
"min": 1,
"definition": "Indicates if the dose is valid or not valid with respect to the published recommendations.",
"isModifier": false,
"short": "Status of the dose relative to published recommendations",
"mapping": [ {
"map": "OBX-5 : OBX-3 = ( 59781-5 )",
"identity": "v2"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EvaluationDoseStatus"
} ],
"description": "The status of the administered dose relative to the published recommendations for the target disease."
},
"max": "1",
"id": "ImmunizationEvaluation.doseStatus",
"base": {
"max": "1",
"min": 1,
"path": "ImmunizationEvaluation.doseStatus"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.doseStatusReason",
"min": 0,
"definition": "Provides an explanation as to why the vaccine administration event is valid or not relative to the published recommendations.",
"isModifier": false,
"short": "Reason for the dose status",
"mapping": [ {
"map": "OBX-5 : OBX-3 = ( 30982-3 )",
"identity": "v2"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"mustSupport": true,
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/immunization-evaluation-dose-status-reason",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "EvaluationDoseStatusReason"
} ],
"description": "The reason the dose status was assigned."
},
"max": "*",
"id": "ImmunizationEvaluation.doseStatusReason",
"base": {
"max": "*",
"min": 0,
"path": "ImmunizationEvaluation.doseStatusReason"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.description",
"min": 0,
"definition": "Additional information about the evaluation.",
"isModifier": false,
"short": "Evaluation notes",
"mapping": [ {
"map": "Event.note",
"identity": "workflow"
}, {
"map": "OBX-5 : OBX-3 = ( 48767-8 )",
"identity": "v2"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ImmunizationEvaluation.description",
"base": {
"max": "1",
"min": 0,
"path": "ImmunizationEvaluation.description"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.series",
"min": 0,
"definition": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"isModifier": false,
"short": "Name of vaccine series",
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "ImmunizationEvaluation.series",
"base": {
"max": "1",
"min": 0,
"path": "ImmunizationEvaluation.series"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.doseNumber[x]",
"min": 0,
"definition": "Nominal position in a series.",
"isModifier": false,
"short": "Dose number within series",
"mapping": [ {
"map": "OBX-5 : OBX-3 = ( 30973-2 )",
"identity": "v2"
} ],
"type": [ {
"code": "positiveInt"
}, {
"code": "string"
} ],
"max": "1",
"id": "ImmunizationEvaluation.doseNumber[x]",
"comment": "The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).",
"base": {
"max": "1",
"min": 0,
"path": "ImmunizationEvaluation.doseNumber[x]"
},
"isSummary": false
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element",
"severity": "error",
"expression": "hasValue() or (children().count() > id.count())"
} ],
"path": "ImmunizationEvaluation.seriesDoses[x]",
"min": 0,
"definition": "The recommended number of doses to achieve immunity.",
"isModifier": false,
"short": "Recommended number of doses for immunity",
"mapping": [ {
"map": "OBX-5 : OBX-3 = ( 59782-3 )",
"identity": "v2"
} ],
"type": [ {
"code": "positiveInt"
}, {
"code": "string"
} ],
"max": "1",
"id": "ImmunizationEvaluation.seriesDoses[x]",
"comment": "The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).",
"base": {
"max": "1",
"min": 0,
"path": "ImmunizationEvaluation.seriesDoses[x]"
},
"isSummary": false
} ]
},
"status": "draft",
"id": "e4812760-3fc6-4e2f-95c9-a13e0d331fc4",
"kind": "resource",
"url": "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunizationevaluation",
"version": "4.1.0",
"differential": {
"element": [ {
"id": "ImmunizationEvaluation",
"path": "ImmunizationEvaluation",
"mapping": [ {
"map": "CarePlan",
"identity": "argonaut-dq-dstu2"
} ],
"mustSupport": false
}, {
"id": "ImmunizationEvaluation.identifier",
"path": "ImmunizationEvaluation.identifier",
"type": [ {
"code": "Identifier"
} ],
"mapping": [ {
"map": "CarePlan.subject",
"identity": "argonaut-dq-dstu2"
} ],
"mustSupport": true
}, {
"id": "ImmunizationEvaluation.status",
"path": "ImmunizationEvaluation.status",
"mustSupport": true
}, {
"id": "ImmunizationEvaluation.patient",
"path": "ImmunizationEvaluation.patient",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-patient" ]
} ],
"mustSupport": true
}, {
"id": "ImmunizationEvaluation.date",
"max": "1",
"min": 1,
"path": "ImmunizationEvaluation.date",
"mustSupport": true
}, {
"id": "ImmunizationEvaluation.authority",
"path": "ImmunizationEvaluation.authority",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-organization" ]
} ],
"mustSupport": false
}, {
"id": "ImmunizationEvaluation.targetDisease",
"max": "1",
"min": 1,
"path": "ImmunizationEvaluation.targetDisease",
"mustSupport": true
}, {
"id": "ImmunizationEvaluation.immunizationEvent",
"max": "1",
"min": 1,
"path": "ImmunizationEvaluation.immunizationEvent",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/us/qicore/StructureDefinition/qicore-immunization" ]
} ],
"mustSupport": true
}, {
"id": "ImmunizationEvaluation.doseStatus",
"max": "1",
"min": 1,
"path": "ImmunizationEvaluation.doseStatus",
"mustSupport": true
}, {
"id": "ImmunizationEvaluation.doseStatusReason",
"path": "ImmunizationEvaluation.doseStatusReason",
"mustSupport": true
} ]
},
"contact": [ {
"name": "Clinical Quality Information WG",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/cqi",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/ImmunizationEvaluation"
}