{
"description": "This Immunization Resource describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed, with further constraints applied to support the Digital Child Health project.",
"_filename": "CareConnect-DCH-Immunization-1.json",
"package_name": "NHSDigital.FHIR.STU3",
"date": "2019-01-11",
"derivation": "constraint",
"meta": {
"lastUpdated": "2018-07-16T12:42:17.467+01:00"
},
"publisher": "NHS Digital",
"fhirVersion": "3.0.1",
"purpose": "CURATED BY INTEROPen see: http://www.interopen.org/careconnect-curation-methodology/",
"name": "CareConnect-DCH-Immunization-1",
"abstract": false,
"copyright": "Copyright © 2019 NHS Digital",
"type": "Immunization",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "1.0.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "pher"
} ],
"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)",
"severity": "error",
"expression": "contained.contained.empty()"
}, {
"key": "dom-1",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"xpath": "not(parent::f:contained and f:text)",
"severity": "error",
"expression": "contained.text.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))",
"severity": "error",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()"
}, {
"key": "dom-3",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"severity": "error",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()"
}, {
"key": "imm-2",
"human": "If immunization was administered (notGiven=false) then explanation.reasonNotGiven SHALL be absent.",
"xpath": "not(f:notGiven/@value=false() and exists(f:explanation/f:reasonNotGiven))",
"severity": "error",
"expression": "(notGiven = true) or explanation.reasonNotGiven.empty()"
}, {
"key": "imm-1",
"human": "If immunization was not administered (notGiven=true) then there SHALL be no reaction nor explanation.reason present",
"xpath": "not(f:notGiven/@value=true() and (count(f:reaction) > 0 or exists(f:explanation/f:reason)))",
"severity": "error",
"expression": "(notGiven = true).not() or (reaction.empty() and explanation.reason.empty())"
} ],
"path": "Immunization",
"min": 0,
"definition": "Describes the event of a patient being administered a vaccination or a record of a vaccination as reported by a patient, a clinician or another party and may include vaccine reaction information and what vaccination protocol was followed.",
"short": "Immunization event information",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "VXU_V04",
"identity": "v2"
}, {
"map": "SubstanceAdministration",
"identity": "rim"
}, {
"map": "clinical.medication",
"identity": "w5"
} ],
"max": "*",
"id": "Immunization",
"base": {
"max": "*",
"min": 0,
"path": "Resource"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.id",
"min": 0,
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"short": "Logical id of this artifact",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "id"
} ],
"max": "1",
"id": "Immunization.id",
"condition": [ "ele-1" ],
"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",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.meta",
"min": 0,
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"short": "Metadata about the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Meta"
} ],
"max": "1",
"id": "Immunization.meta",
"condition": [ "ele-1" ],
"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",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.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.",
"isModifier": true,
"short": "A set of rules under which this content was created",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.implicitRules",
"condition": [ "ele-1" ],
"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. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"base": {
"max": "1",
"min": 0,
"path": "Resource.implicitRules"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.language",
"min": 0,
"definition": "The base language in which the resource is written.",
"short": "Language of the resource content",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "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.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages"
}
},
"max": "1",
"id": "Immunization.language",
"condition": [ "ele-1" ],
"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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.text",
"min": 0,
"definition": "A human-readable narrative that contains a summary of the resource, and may 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.",
"short": "Text summary of the resource, for human interpretation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
}, {
"map": "Act.text?",
"identity": "rim"
} ],
"type": [ {
"code": "Narrative"
} ],
"alias": [ "narrative", "html", "xhtml", "display" ],
"max": "1",
"id": "Immunization.text",
"condition": [ "ele-1", "dom-1" ],
"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 in formation is added later.",
"base": {
"max": "1",
"min": 0,
"path": "DomainResource.text"
}
}, {
"path": "Immunization.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.",
"short": "Contained, inline Resources",
"mapping": [ {
"map": "Entity. Role, or Act",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Resource"
} ],
"alias": [ "inline resources", "anonymous resources", "contained resources" ],
"max": "*",
"id": "Immunization.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.",
"base": {
"max": "*",
"min": 0,
"path": "DomainResource.contained"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.extension",
"condition": [ "ele-1" ],
"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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1"
} ],
"sliceName": "parentPresent",
"alias": [ "extensions", "user content" ],
"max": "1",
"id": "Immunization.extension:parentPresent",
"condition": [ "ele-1" ],
"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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.extension.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.extension:parentPresent.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.extension:parentPresent.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.extension:parentPresent.url",
"condition": [ "ele-1" ],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.extension.value[x]",
"min": 0,
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"short": "Value of extension",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "markdown"
}, {
"code": "oid"
}, {
"code": "positiveInt"
}, {
"code": "string"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "Address"
}, {
"code": "Age"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "ContactPoint"
}, {
"code": "Count"
}, {
"code": "Distance"
}, {
"code": "Duration"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Money"
}, {
"code": "Period"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "Reference"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "1",
"id": "Immunization.extension:parentPresent.value[x]",
"condition": [ "ele-1" ],
"comment": "A stream of bytes, base64 encoded",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.",
"short": "The date that the Vaccination was recorded",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1"
} ],
"sliceName": "recordedDate",
"alias": [ "extensions", "user content" ],
"max": "1",
"id": "Immunization.extension:recordedDate",
"condition": [ "ele-1" ],
"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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.extension.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.extension:recordedDate.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.extension:recordedDate.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.extension:recordedDate.url",
"condition": [ "ele-1" ],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.extension.value[x]",
"min": 0,
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"short": "Value of extension",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "markdown"
}, {
"code": "oid"
}, {
"code": "positiveInt"
}, {
"code": "string"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "Address"
}, {
"code": "Age"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "ContactPoint"
}, {
"code": "Count"
}, {
"code": "Distance"
}, {
"code": "Duration"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Money"
}, {
"code": "Period"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "Reference"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "1",
"id": "Immunization.extension:recordedDate.value[x]",
"condition": [ "ele-1" ],
"comment": "A stream of bytes, base64 encoded",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.extension",
"min": 1,
"definition": "May be used to represent additional information that is not part of the basic definition of the resource. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1"
} ],
"sliceName": "vaccinationProcedure",
"alias": [ "extensions", "user content" ],
"max": "1",
"id": "Immunization.extension:vaccinationProcedure",
"condition": [ "ele-1" ],
"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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.extension.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.extension:vaccinationProcedure.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.extension:vaccinationProcedure.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.extension:vaccinationProcedure.url",
"condition": [ "ele-1" ],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.extension.value[x]",
"min": 0,
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"short": "Value of extension",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "markdown"
}, {
"code": "oid"
}, {
"code": "positiveInt"
}, {
"code": "string"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "Address"
}, {
"code": "Age"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "ContactPoint"
}, {
"code": "Count"
}, {
"code": "Distance"
}, {
"code": "Duration"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Money"
}, {
"code": "Period"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "Reference"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "1",
"id": "Immunization.extension:vaccinationProcedure.value[x]",
"condition": [ "ele-1" ],
"comment": "A stream of bytes, base64 encoded",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.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. Usually modifier elements provide negation or qualification. In order 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.modifierExtension",
"condition": [ "ele-1" ],
"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"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.identifier",
"min": 0,
"definition": "A unique identifier assigned to this immunization record.",
"short": "Business identifier",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": "Event.identifier",
"identity": "workflow"
}, {
"map": ".id",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id",
"identity": "cda"
}, {
"map": "id",
"identity": "w5"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "*",
"id": "Immunization.identifier",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Immunization.identifier"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.identifier.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.identifier.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.identifier.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.identifier.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.identifier.use",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"definition": "The purpose of this identifier.",
"isModifier": true,
"short": "usual | official | temp | secondary (If known)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
} ],
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
"max": "1",
"id": "Immunization.identifier.use",
"condition": [ "ele-1" ],
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.use"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.identifier.type",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"short": "Description of identifier",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "CX.5",
"identity": "v2"
}, {
"map": "Role.code or implied by context",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean": true
} ],
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-type"
}
},
"max": "1",
"id": "Immunization.identifier.type",
"condition": [ "ele-1" ],
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.type"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.identifier.system",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 1,
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"short": "The namespace for the identifier value",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX.4 / EI-2-4",
"identity": "v2"
}, {
"map": "II.root or Role.id.root",
"identity": "rim"
}, {
"map": "./IdentifierType",
"identity": "servd"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.identifier.system",
"condition": [ "ele-1" ],
"comment": "see http://en.wikipedia.org/wiki/Uniform_resource_identifier",
"example": [ {
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.identifier.value",
"min": 1,
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"short": "The value that is unique",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX.1 / EI.1",
"identity": "v2"
}, {
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)",
"identity": "rim"
}, {
"map": "./Value",
"identity": "servd"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.identifier.value",
"condition": [ "ele-1" ],
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](extension-rendered-value.html).",
"example": [ {
"label": "General",
"valueString": "123456"
} ],
"base": {
"max": "1",
"min": 0,
"path": "Identifier.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "per-1",
"human": "If present, start SHALL have a lower value than end",
"xpath": "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)",
"severity": "error",
"expression": "start.empty() or end.empty() or (start <= end)"
} ],
"path": "Immunization.identifier.period",
"min": 0,
"definition": "Time period during which identifier is/was valid for use.",
"short": "Time period when id is/was valid for use",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "DR",
"identity": "v2"
}, {
"map": "IVL[lowClosed=\"true\" and highClosed=\"true\"] or URG[lowClosed=\"true\" and highClosed=\"true\"]",
"identity": "rim"
}, {
"map": "CX.7 + CX.8",
"identity": "v2"
}, {
"map": "Role.effectiveTime or implied by context",
"identity": "rim"
}, {
"map": "./StartDate and ./EndDate",
"identity": "servd"
} ],
"type": [ {
"code": "Period"
} ],
"max": "1",
"id": "Immunization.identifier.period",
"condition": [ "ele-1" ],
"comment": "This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. \"the patient was an inpatient of the hospital for this time range\") or one value from the range applies (e.g. \"give to the patient between these two times\"). If duration is required, specify the type as Interval|Duration.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.period"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"severity": "error",
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))"
} ],
"path": "Immunization.identifier.assigner",
"min": 0,
"definition": "Organization that issued/manages the identifier.",
"short": "Organization that issued id (may be just text)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "CX.4 / (CX.4,CX.9,CX.10)",
"identity": "v2"
}, {
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper",
"identity": "rim"
}, {
"map": "./IdentifierIssuingAuthority",
"identity": "servd"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1"
} ],
"max": "1",
"id": "Immunization.identifier.assigner",
"condition": [ "ele-1" ],
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"base": {
"max": "1",
"min": 0,
"path": "Identifier.assigner"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.status",
"fixedCode": "completed",
"min": 1,
"definition": "Indicates the current status of the vaccination event.",
"isModifier": true,
"short": "completed",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Event.status",
"identity": "workflow"
}, {
"map": "statusCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationStatus"
} ],
"description": "A set of codes indicating the current status of an Immunization",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-status"
}
},
"max": "1",
"id": "Immunization.status",
"condition": [ "ele-1" ],
"comment": "Will generally be set to show that the immunization has been completed.\n\nThis element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.status"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.notGiven",
"min": 1,
"definition": "Indicates if the vaccination was or was not given.",
"isModifier": true,
"short": "Flag for whether immunization was given",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Event.notDone",
"identity": "workflow"
}, {
"map": "[actionNegationInd=true].reasonCode",
"identity": "rim"
}, {
"map": "status",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.notGiven",
"condition": [ "ele-1" ],
"comment": "This element is labeled as a modifier because it indicates that an immunization didn't happen.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.notGiven"
},
"fixedBoolean": false,
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccineCode",
"min": 1,
"definition": "Vaccine that was administered or was to be administered.",
"short": "Vaccine product administered",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "Event.code",
"identity": "workflow"
}, {
"map": "RXA-5",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code",
"identity": "cda"
}, {
"map": "what",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccineCode"
} ],
"description": "The code for vaccine product administered",
"valueSetReference": {
"reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-VaccineCode-1"
}
},
"max": "1",
"id": "Immunization.vaccineCode",
"condition": [ "ele-1" ],
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.vaccineCode"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccineCode.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccineCode.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.vaccineCode.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccineCode.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccineCode.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
}, {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Immunization.vaccineCode.coding",
"condition": [ "ele-1" ],
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccineCode.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccineCode.coding.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.vaccineCode.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccineCode.coding.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccineCode.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "http://snomed.info/sct",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding.system",
"condition": [ "ele-1" ],
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccineCode.coding.version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding.version",
"condition": [ "ele-1" ],
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccineCode.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding.code",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccineCode.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 1,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding.display",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccineCode.coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.vaccineCode.coding.userSelected",
"condition": [ "ele-1" ],
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccineCode.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccineCode.text",
"condition": [ "ele-1" ],
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"severity": "error",
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))"
} ],
"path": "Immunization.patient",
"min": 1,
"definition": "The patient who either received or did not receive the immunization.",
"short": "Who was immunized",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "Event.subject",
"identity": "workflow"
}, {
"map": "PID-3",
"identity": "v2"
}, {
"map": ".partipication[ttypeCode=].role",
"identity": "rim"
}, {
"map": "who.focus",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-DCH-Patient-1"
} ],
"max": "1",
"id": "Immunization.patient",
"condition": [ "ele-1" ],
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.patient"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.patient.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.patient.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.patient.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.patient.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.patient.reference",
"min": 1,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.patient.reference",
"condition": [ "ele-1", "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.patient.identifier",
"min": 0,
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "Immunization.patient.identifier",
"condition": [ "ele-1" ],
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.patient.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.patient.display",
"condition": [ "ele-1" ],
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"severity": "error",
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))"
} ],
"path": "Immunization.encounter",
"min": 1,
"definition": "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.",
"short": "Encounter administered as part of",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "Event.context",
"identity": "workflow"
}, {
"map": "PV1-19",
"identity": "v2"
}, {
"map": "component->EncounterEvent",
"identity": "rim"
}, {
"map": "context",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-DCH-Encounter-1"
} ],
"max": "1",
"id": "Immunization.encounter",
"condition": [ "ele-1" ],
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.encounter"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.encounter.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.encounter.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.encounter.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.encounter.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.encounter.reference",
"min": 1,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.encounter.reference",
"condition": [ "ele-1", "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.encounter.identifier",
"min": 0,
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "Immunization.encounter.identifier",
"condition": [ "ele-1" ],
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.encounter.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.encounter.display",
"condition": [ "ele-1" ],
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.date",
"min": 0,
"definition": "The date on which the vaccination intervention was carried out or was meant to be administered.",
"short": "Vaccination administration date",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Event.occurrence.occurrenceDateTime",
"identity": "workflow"
}, {
"map": "RXA-3",
"identity": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value",
"identity": "cda"
}, {
"map": "when.init",
"identity": "w5"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Immunization.date",
"condition": [ "ele-1" ],
"comment": "When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.date"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.primarySource",
"min": 1,
"definition": "An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.",
"short": "Indicates context the data was recorded in",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "RXA-9",
"identity": "v2"
}, {
"map": "immunization.uncertaintycode (if primary source=false, uncertainty=U)",
"identity": "rim"
}, {
"map": "who.source",
"identity": "w5"
} ],
"type": [ {
"code": "boolean"
} ],
"defaultValueBoolean": true,
"max": "1",
"id": "Immunization.primarySource",
"condition": [ "ele-1" ],
"comment": "Reflects the “reliability” of the content.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.primarySource"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.reportOrigin",
"min": 0,
"definition": "The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.",
"short": "Indicates the source of a secondarily reported record",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "RXA-9",
"identity": "v2"
}, {
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported)\n.participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional)\n.participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)",
"identity": "rim"
}, {
"map": "who.source",
"identity": "w5"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationReportOrigin"
} ],
"description": "The source of the data for a record which is not from a primary source.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-origin"
}
},
"max": "1",
"id": "Immunization.reportOrigin",
"condition": [ "ele-1" ],
"comment": "Should not be populated if primarySource = True, will not be required even if primarySource = False.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.reportOrigin"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"severity": "error",
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))"
} ],
"path": "Immunization.location",
"min": 1,
"definition": "The service delivery location where the vaccine administration occurred.",
"short": "Where vaccination occurred",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "RXA-27 (or RXA-11, deprecated as of v2.7)",
"identity": "v2"
}, {
"map": ".participation[typeCode=LOC].COCT_MT240000UV",
"identity": "rim"
}, {
"map": "where",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1"
} ],
"max": "1",
"id": "Immunization.location",
"condition": [ "ele-1" ],
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.location"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.location.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.location.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.location.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.location.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.location.reference",
"min": 1,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.location.reference",
"condition": [ "ele-1", "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.location.identifier",
"min": 0,
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "Immunization.location.identifier",
"condition": [ "ele-1" ],
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.location.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.location.display",
"condition": [ "ele-1" ],
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"severity": "error",
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))"
} ],
"path": "Immunization.manufacturer",
"min": 0,
"definition": "Name of vaccine manufacturer.",
"short": "Vaccine manufacturer",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "RXA-17",
"identity": "v2"
}, {
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name",
"identity": "cda"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1"
} ],
"max": "1",
"id": "Immunization.manufacturer",
"condition": [ "ele-1" ],
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.manufacturer"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.lotNumber",
"min": 0,
"definition": "Lot number of the vaccine product.",
"short": "Vaccine lot number",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "RXA-15",
"identity": "v2"
}, {
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText",
"identity": "cda"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.lotNumber",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.lotNumber"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.expirationDate",
"min": 0,
"definition": "Date vaccine batch expires.",
"short": "Vaccine expiration date",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "RXA-16",
"identity": "v2"
}, {
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime",
"identity": "rim"
} ],
"type": [ {
"code": "date"
} ],
"max": "1",
"id": "Immunization.expirationDate",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Immunization.expirationDate"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.site",
"min": 0,
"definition": "Body site where vaccine was administered.",
"short": "Body site vaccine was administered",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "RXR-2",
"identity": "v2"
}, {
"map": "observation.targetSiteCode",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationSite"
} ],
"description": "The site at which the vaccine was administered",
"valueSetReference": {
"reference": "https://fhir.nhs.uk/STU3/ValueSet/DCH-ImmunisationSite-1"
}
},
"max": "1",
"id": "Immunization.site",
"condition": [ "ele-1" ],
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.site"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.site.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.site.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.site.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.site.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.site.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
}, {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "1",
"id": "Immunization.site.coding",
"condition": [ "ele-1" ],
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.site.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.site.coding.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.site.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.site.coding.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.site.coding.extension",
"min": 0,
"definition": "The SNOMED CT Description ID for the display.",
"short": "The SNOMED CT Description ID for the display",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
} ],
"sliceName": "snomedCTDescriptionID",
"alias": [ "extensions", "user content" ],
"max": "1",
"id": "Immunization.site.coding.extension:snomedCTDescriptionID",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.site.coding.extension.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.site.coding.extension:snomedCTDescriptionID.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.site.coding.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.site.coding.extension:snomedCTDescriptionID.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.site.coding.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.site.coding.extension:snomedCTDescriptionID.url",
"condition": [ "ele-1" ],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.site.coding.extension.value[x]",
"min": 0,
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"short": "Value of extension",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "markdown"
}, {
"code": "oid"
}, {
"code": "positiveInt"
}, {
"code": "string"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "Address"
}, {
"code": "Age"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "ContactPoint"
}, {
"code": "Count"
}, {
"code": "Distance"
}, {
"code": "Duration"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Money"
}, {
"code": "Period"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "Reference"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "1",
"id": "Immunization.site.coding.extension:snomedCTDescriptionID.value[x]",
"condition": [ "ele-1" ],
"comment": "A stream of bytes, base64 encoded",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.site.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "http://snomed.info/sct",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.site.coding.system",
"condition": [ "ele-1" ],
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.site.coding.version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.site.coding.version",
"condition": [ "ele-1" ],
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.site.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.site.coding.code",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.site.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 1,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.site.coding.display",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.site.coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.site.coding.userSelected",
"condition": [ "ele-1" ],
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.site.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.site.text",
"condition": [ "ele-1" ],
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.route",
"min": 0,
"definition": "The path by which the vaccine product is taken into the body.",
"short": "How vaccine entered body",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "RXR-1",
"identity": "v2"
}, {
"map": ".routeCode",
"identity": "rim"
}, {
"map": "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code",
"identity": "cda"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRoute"
} ],
"description": "The route by which the vaccine was administered",
"valueSetReference": {
"reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-MedicationDosageRoute-1"
}
},
"max": "1",
"id": "Immunization.route",
"condition": [ "ele-1" ],
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.route"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.route.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.route.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.route.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.route.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.route.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
}, {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "1",
"id": "Immunization.route.coding",
"condition": [ "ele-1" ],
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.route.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.route.coding.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.route.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.route.coding.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.route.coding.extension",
"min": 0,
"definition": "The SNOMED CT Description ID for the display.",
"short": "The SNOMED CT Description ID for the display",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
} ],
"sliceName": "snomedCTDescriptionID",
"alias": [ "extensions", "user content" ],
"max": "1",
"id": "Immunization.route.coding.extension:snomedCTDescriptionID",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.route.coding.extension.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.route.coding.extension:snomedCTDescriptionID.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.route.coding.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.route.coding.extension:snomedCTDescriptionID.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.route.coding.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.route.coding.extension:snomedCTDescriptionID.url",
"condition": [ "ele-1" ],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.route.coding.extension.value[x]",
"min": 0,
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"short": "Value of extension",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "markdown"
}, {
"code": "oid"
}, {
"code": "positiveInt"
}, {
"code": "string"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "Address"
}, {
"code": "Age"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "ContactPoint"
}, {
"code": "Count"
}, {
"code": "Distance"
}, {
"code": "Duration"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Money"
}, {
"code": "Period"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "Reference"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "1",
"id": "Immunization.route.coding.extension:snomedCTDescriptionID.value[x]",
"condition": [ "ele-1" ],
"comment": "A stream of bytes, base64 encoded",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.route.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "http://snomed.info/sct",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.route.coding.system",
"condition": [ "ele-1" ],
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.route.coding.version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.route.coding.version",
"condition": [ "ele-1" ],
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.route.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.route.coding.code",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.route.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 1,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.route.coding.display",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.route.coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.route.coding.userSelected",
"condition": [ "ele-1" ],
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.route.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.route.text",
"condition": [ "ele-1" ],
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "qty-3",
"human": "If a code for the unit is present, the system SHALL also be present",
"xpath": "not(exists(f:code)) or exists(f:system)",
"severity": "error",
"expression": "code.empty() or system.exists()"
}, {
"key": "sqty-1",
"human": "The comparator is not used on a SimpleQuantity",
"xpath": "not(exists(f:comparator))",
"severity": "error",
"expression": "comparator.empty()"
} ],
"path": "Immunization.doseQuantity",
"min": 0,
"definition": "The quantity of vaccine product that was administered.",
"isModifier": false,
"short": "Amount of vaccine administered",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "SN (see also Range) or CQ",
"identity": "v2"
}, {
"map": "PQ, IVL, MO, CO, depending on the values",
"identity": "rim"
}, {
"map": "RXA-6 / RXA-7.1",
"identity": "v2"
}, {
"map": ".doseQuantity",
"identity": "rim"
} ],
"type": [ {
"code": "Quantity",
"profile": "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
} ],
"max": "1",
"id": "Immunization.doseQuantity",
"condition": [ "ele-1" ],
"comment": "The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.doseQuantity"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.doseQuantity.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.doseQuantity.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.doseQuantity.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.doseQuantity.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.doseQuantity.value",
"requirements": "Precision is handled implicitly in almost all cases of measurement.",
"min": 0,
"definition": "The value of the measured amount. The value includes an implicit precision in the presentation of the value.",
"short": "Numerical value (with implicit precision)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "SN.2 / CQ - N/A",
"identity": "v2"
}, {
"map": "PQ.value, CO.value, MO.value, IVL.high or IVL.low depending on the value",
"identity": "rim"
} ],
"type": [ {
"code": "decimal"
} ],
"max": "1",
"id": "Immunization.doseQuantity.value",
"condition": [ "ele-1" ],
"comment": "The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.value"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.doseQuantity.comparator",
"requirements": "Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.",
"min": 0,
"definition": "Not allowed to be used in this context",
"isModifier": true,
"short": "< | <= | >= | > - how to understand the value",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "SN.1 / CQ.1",
"identity": "v2"
}, {
"map": "IVL properties",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"meaningWhenMissing": "If there is no comparator, then there is no modification of the value",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "QuantityComparator"
} ],
"description": "How the Quantity should be understood and represented.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/quantity-comparator"
}
},
"max": "0",
"id": "Immunization.doseQuantity.comparator",
"condition": [ "ele-1" ],
"comment": "This is labeled as \"Is Modifier\" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value.",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.comparator"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.doseQuantity.unit",
"requirements": "There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.",
"min": 0,
"definition": "A human-readable form of the unit.",
"short": "Units of measure (from DM+D)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "PQ.unit",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.doseQuantity.unit",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.unit"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.doseQuantity.system",
"requirements": "Need to know the system that defines the coded form of the unit.",
"min": 0,
"definition": "The identification of the system that provides the coded form of the unit.",
"short": "System that defines coded unit form",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "CO.codeSystem, PQ.translation.codeSystem",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.doseQuantity.system",
"condition": [ "ele-1", "qty-3" ],
"comment": "see http://en.wikipedia.org/wiki/Uniform_resource_identifier",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.doseQuantity.code",
"requirements": "Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.",
"min": 0,
"definition": "A computer processable form of the unit in some unit representation system.",
"short": "Coded form of the unit",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "(see OBX.6 etc.) / CQ.2",
"identity": "v2"
}, {
"map": "PQ.code, MO.currency, PQ.translation.code",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.doseQuantity.code",
"condition": [ "ele-1" ],
"comment": "The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.",
"base": {
"max": "1",
"min": 0,
"path": "Quantity.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.practitioner",
"min": 1,
"definition": "Indicates who or what performed the event.",
"short": "Who performed event",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Event.performer",
"identity": "workflow"
}, {
"map": "ORC-12 / RXA-10",
"identity": "v2"
}, {
"map": ".participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "Immunization.practitioner",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Immunization.practitioner"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.practitioner.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.practitioner.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.practitioner.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.practitioner.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.practitioner.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Immunization.practitioner.modifierExtension",
"condition": [ "ele-1" ],
"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": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.practitioner.role",
"min": 0,
"definition": "Describes the type of performance (e.g. ordering provider, administering provider, etc.).",
"short": "What type of performance was done",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "Event.performer.role",
"identity": "workflow"
}, {
"map": ".participation.functionCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRole"
} ],
"description": "The role a practitioner plays in the immunization event",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/immunization-role"
}
},
"max": "1",
"id": "Immunization.practitioner.role",
"condition": [ "ele-1" ],
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.practitioner.role"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"severity": "error",
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))"
} ],
"path": "Immunization.practitioner.actor",
"min": 1,
"definition": "The device, practitioner, etc. who performed the action.",
"short": "Individual who was performing",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "Event.performer.actor",
"identity": "workflow"
}, {
"map": ".player",
"identity": "rim"
}, {
"map": "who.actor",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-DCH-Practitioner-1"
} ],
"max": "1",
"id": "Immunization.practitioner.actor",
"condition": [ "ele-1" ],
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.practitioner.actor"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.practitioner.actor.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.practitioner.actor.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.practitioner.actor.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.practitioner.actor.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.practitioner.actor.reference",
"min": 1,
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"short": "Literal reference, Relative, internal or absolute URL",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.practitioner.actor.reference",
"condition": [ "ele-1", "ref-1" ],
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.reference"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.practitioner.actor.identifier",
"min": 0,
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"short": "Logical reference, when literal reference is not known",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CX / EI (occasionally, more often EI maps to a resource id or a URL)",
"identity": "v2"
}, {
"map": "II - see see identifier pattern at http://wiki.hl7.org/index.php?title=Common_Design_Patterns#Identifier_Pattern for relevant discussion. The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]",
"identity": "rim"
}, {
"map": "Identifier",
"identity": "servd"
}, {
"map": ".identifier",
"identity": "rim"
} ],
"type": [ {
"code": "Identifier"
} ],
"max": "1",
"id": "Immunization.practitioner.actor.identifier",
"condition": [ "ele-1" ],
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.identifier"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.practitioner.actor.display",
"min": 0,
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"short": "Text alternative for the resource",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.practitioner.actor.display",
"condition": [ "ele-1" ],
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"base": {
"max": "1",
"min": 0,
"path": "Reference.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.note",
"min": 0,
"definition": "Extra information about the immunization that is not conveyed by the other attributes.",
"short": "Vaccination notes",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "v2"
}, {
"map": "Act",
"identity": "rim"
}, {
"map": "Event.note",
"identity": "workflow"
}, {
"map": "note",
"identity": "rim"
} ],
"type": [ {
"code": "Annotation"
} ],
"max": "*",
"id": "Immunization.note",
"condition": [ "ele-1" ],
"comment": "For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. *Annotations SHOULD NOT* be used to communicate \"modifying\" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.note"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.note.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.note.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.note.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.note.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"severity": "error",
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))"
} ],
"path": "Immunization.note.author[x]",
"min": 0,
"definition": "The individual responsible for making the annotation.",
"short": "Individual responsible for the annotation",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "N/A",
"identity": "v2"
}, {
"map": "Act.participant[typeCode=AUT].role",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}, {
"code": "string"
}, {
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1"
}, {
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1"
} ],
"max": "1",
"id": "Immunization.note.author[x]",
"condition": [ "ele-1" ],
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 0,
"path": "Annotation.author[x]"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.note.time",
"min": 0,
"definition": "Indicates when this particular annotation was made.",
"short": "When the annotation was made",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "v2"
}, {
"map": "Act.effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Immunization.note.time",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Annotation.time"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.note.text",
"min": 1,
"definition": "The text of the annotation.",
"short": "The annotation - text content",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "v2"
}, {
"map": "Act.text",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.note.text",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 1,
"path": "Annotation.text"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation",
"min": 0,
"definition": "Reasons why a vaccine was or was not administered.",
"short": "Administration/non-administration reasons",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "1",
"id": "Immunization.explanation",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Immunization.explanation"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.explanation.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.explanation.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.explanation.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.explanation.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Immunization.explanation.modifierExtension",
"condition": [ "ele-1" ],
"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": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reason",
"min": 0,
"definition": "Reasons why a vaccine was administered.",
"short": "Why immunization occurred",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "Event.reasonCodeableConcept",
"identity": "workflow"
}, {
"map": "[actionNegationInd=false].reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationReason"
} ],
"description": "The reason why a vaccine was administered",
"valueSetReference": {
"reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-ImmunizationExplanationReason-1"
}
},
"max": "*",
"id": "Immunization.explanation.reason",
"condition": [ "ele-1" ],
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.explanation.reason"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reason.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.explanation.reason.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.explanation.reason.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.explanation.reason.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reason.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
}, {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Immunization.explanation.reason.coding",
"condition": [ "ele-1" ],
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reason.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.explanation.reason.coding.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.explanation.reason.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.explanation.reason.coding.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reason.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "http://snomed.info/sct",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.explanation.reason.coding.system",
"condition": [ "ele-1" ],
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reason.coding.version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.explanation.reason.coding.version",
"condition": [ "ele-1" ],
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reason.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.explanation.reason.coding.code",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reason.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 1,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.explanation.reason.coding.display",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reason.coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.explanation.reason.coding.userSelected",
"condition": [ "ele-1" ],
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reason.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.explanation.reason.text",
"condition": [ "ele-1" ],
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reasonNotGiven",
"min": 0,
"definition": "Reason why a vaccine was not administered.",
"short": "Why immunization did not occur",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "Event.notDoneReason",
"identity": "workflow"
}, {
"map": "RXA-18",
"identity": "v2"
}, {
"map": "[actionNegationInd=true].reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NoImmunizationReason"
} ],
"description": "The reason why a vaccine was not administered",
"valueSetReference": {
"reference": "https://fhir.nhs.uk/STU3/ValueSet/DCH-ReasonNotAdminsitered-1"
}
},
"max": "*",
"id": "Immunization.explanation.reasonNotGiven",
"condition": [ "ele-1" ],
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.explanation.reasonNotGiven"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reasonNotGiven.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.explanation.reasonNotGiven.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.explanation.reasonNotGiven.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.explanation.reasonNotGiven.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reasonNotGiven.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
}, {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Immunization.explanation.reasonNotGiven.coding",
"condition": [ "ele-1" ],
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reasonNotGiven.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.explanation.reasonNotGiven.coding.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.explanation.reasonNotGiven.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.explanation.reasonNotGiven.coding.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reasonNotGiven.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "http://snomed.info/sct",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.explanation.reasonNotGiven.coding.system",
"condition": [ "ele-1" ],
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reasonNotGiven.coding.version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.explanation.reasonNotGiven.coding.version",
"condition": [ "ele-1" ],
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reasonNotGiven.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.explanation.reasonNotGiven.coding.code",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reasonNotGiven.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 1,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.explanation.reasonNotGiven.coding.display",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reasonNotGiven.coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.explanation.reasonNotGiven.coding.userSelected",
"condition": [ "ele-1" ],
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.explanation.reasonNotGiven.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.explanation.reasonNotGiven.text",
"condition": [ "ele-1" ],
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.reaction",
"min": 0,
"definition": "Categorical data indicating that an adverse event is associated in time to an immunization.",
"short": "Details of a reaction that follows immunization",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "OBX-3",
"identity": "v2"
}, {
"map": "Observation[classCode=obs].code",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Immunization.reaction",
"condition": [ "ele-1" ],
"comment": "A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new [AllergyIntolerance](allergyintolerance.html) resource instance as most systems will not query against past Immunization.reaction elements.",
"base": {
"max": "*",
"min": 0,
"path": "Immunization.reaction"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.reaction.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.reaction.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.reaction.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.reaction.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.reaction.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Immunization.reaction.modifierExtension",
"condition": [ "ele-1" ],
"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": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.reaction.date",
"min": 0,
"definition": "Date of reaction to the immunization.",
"short": "When reaction started",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "OBX-14 (ideally this would be reported in an IAM segment, but IAM is not part of the HL7 v2 VXU message - most likely would appear in OBX segments if at all)",
"identity": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
} ],
"type": [ {
"code": "dateTime"
} ],
"max": "1",
"id": "Immunization.reaction.date",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Immunization.reaction.date"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"severity": "error",
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))"
} ],
"path": "Immunization.reaction.detail",
"min": 0,
"definition": "Details of the reaction.",
"short": "Additional information on reaction",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "OBX-5",
"identity": "v2"
}, {
"map": ".value",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Observation-1"
} ],
"max": "1",
"id": "Immunization.reaction.detail",
"condition": [ "ele-1" ],
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.reaction.detail"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.reaction.reported",
"min": 0,
"definition": "Self-reported indicator.",
"short": "Indicates self-reported reaction",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "(no such concept seems to exist for allergy/adverse reaction in HL7 v2)",
"identity": "v2"
}, {
"map": ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)",
"identity": "rim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.reaction.reported",
"condition": [ "ele-1" ],
"base": {
"max": "1",
"min": 0,
"path": "Immunization.reaction.reported"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol",
"min": 0,
"definition": "Contains information about the protocol(s) under which the vaccine was administered.",
"short": "What protocol was followed",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "(HL7 v2 doesn't seem to provide for this)",
"identity": "v2"
}, {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]",
"identity": "rim"
} ],
"type": [ {
"code": "BackboneElement"
} ],
"max": "*",
"id": "Immunization.vaccinationProtocol",
"condition": [ "ele-1" ],
"base": {
"max": "*",
"min": 0,
"path": "Immunization.vaccinationProtocol"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccinationProtocol.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.vaccinationProtocol.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccinationProtocol.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.vaccinationProtocol.modifierExtension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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.",
"isModifier": true,
"short": "Extensions that cannot be ignored",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content", "modifiers" ],
"max": "*",
"id": "Immunization.vaccinationProtocol.modifierExtension",
"condition": [ "ele-1" ],
"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": "BackboneElement.modifierExtension"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.doseSequence",
"min": 1,
"definition": "Nominal position in a series.",
"short": "Dose number within series",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.doseSequence",
"condition": [ "ele-1" ],
"comment": "32 bit number; for values larger than this, use decimal",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.doseSequence"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.description",
"min": 0,
"definition": "Contains the description about the protocol under which the vaccine was administered.",
"short": "Details of vaccine protocol",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.description",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.description"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
}, {
"key": "ref-1",
"human": "SHALL have a contained resource if a local reference is provided",
"xpath": "not(starts-with(f:reference/@value, '#')) or exists(ancestor::*[self::f:entry or self::f:parameter]/f:resource/f:*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')]|/*/f:contained/f:*[f:id/@value=substring-after(current()/f:reference/@value, '#')])",
"severity": "error",
"expression": "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))"
} ],
"path": "Immunization.vaccinationProtocol.authority",
"min": 0,
"definition": "Indicates the authority who published the protocol. E.g. ACIP.",
"short": "Who is responsible for protocol",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "The target of a resource reference is a RIM entry point (Act, Role, or Entity)",
"identity": "rim"
}, {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV",
"identity": "rim"
} ],
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.authority",
"condition": [ "ele-1" ],
"comment": "References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.authority"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.series",
"min": 0,
"definition": "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"short": "Name of vaccine series",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM]",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.series",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.series"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.seriesDoses",
"min": 0,
"definition": "The recommended number of doses to achieve immunity.",
"short": "Recommended number of doses for immunity",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text",
"identity": "rim"
} ],
"type": [ {
"code": "positiveInt"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.seriesDoses",
"condition": [ "ele-1" ],
"comment": "32 bit number; for values larger than this, use decimal",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.seriesDoses"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease",
"min": 1,
"definition": "The targeted disease.",
"short": "Disease immunized against",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": "outboundRelationship.target[classCode=OBS].code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccinationProtocoltargetDisease"
} ],
"description": "The disease target of the vaccination protocol",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-target"
}
},
"max": "*",
"id": "Immunization.vaccinationProtocol.targetDisease",
"condition": [ "ele-1" ],
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "*",
"min": 1,
"path": "Immunization.vaccinationProtocol.targetDisease"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccinationProtocol.targetDisease.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccinationProtocol.targetDisease.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
}, {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "system",
"type": "value"
} ]
},
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Immunization.vaccinationProtocol.targetDisease.coding",
"condition": [ "ele-1" ],
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
}, {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"sliceName": "snomedCT",
"max": "1",
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT",
"condition": [ "ele-1" ],
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
} ],
"sliceName": "snomedCTDescriptionID",
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.extension:snomedCTDescriptionID",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.coding.extension.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.extension:snomedCTDescriptionID.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.coding.extension.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.extension:snomedCTDescriptionID.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.coding.extension.url",
"min": 1,
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"short": "identifies the meaning of the extension",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "uri"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.extension:snomedCTDescriptionID.url",
"condition": [ "ele-1" ],
"comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
"base": {
"max": "1",
"min": 1,
"path": "Extension.url"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.coding.extension.value[x]",
"min": 0,
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"short": "Value of extension",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"type": [ {
"code": "base64Binary"
}, {
"code": "boolean"
}, {
"code": "code"
}, {
"code": "date"
}, {
"code": "dateTime"
}, {
"code": "decimal"
}, {
"code": "id"
}, {
"code": "instant"
}, {
"code": "integer"
}, {
"code": "markdown"
}, {
"code": "oid"
}, {
"code": "positiveInt"
}, {
"code": "string"
}, {
"code": "time"
}, {
"code": "unsignedInt"
}, {
"code": "uri"
}, {
"code": "Address"
}, {
"code": "Age"
}, {
"code": "Annotation"
}, {
"code": "Attachment"
}, {
"code": "CodeableConcept"
}, {
"code": "Coding"
}, {
"code": "ContactPoint"
}, {
"code": "Count"
}, {
"code": "Distance"
}, {
"code": "Duration"
}, {
"code": "HumanName"
}, {
"code": "Identifier"
}, {
"code": "Money"
}, {
"code": "Period"
}, {
"code": "Quantity"
}, {
"code": "Range"
}, {
"code": "Ratio"
}, {
"code": "Reference"
}, {
"code": "SampledData"
}, {
"code": "Signature"
}, {
"code": "Timing"
}, {
"code": "Meta"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.extension:snomedCTDescriptionID.value[x]",
"condition": [ "ele-1" ],
"comment": "A stream of bytes, base64 encoded",
"base": {
"max": "1",
"min": 0,
"path": "Extension.value[x]"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"fixedUri": "http://snomed.info/sct",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.system",
"condition": [ "ele-1" ],
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.coding.version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "0",
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.version",
"condition": [ "ele-1" ],
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.code",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 1,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.display",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.userSelected",
"condition": [ "ele-1" ],
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.targetDisease.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.targetDisease.text",
"condition": [ "ele-1" ],
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.doseStatus",
"min": 1,
"definition": "Indicates if the immunization event should \"count\" against the protocol.",
"short": "Indicates if dose counts towards immunity",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].value",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccinationProtocolDoseStatus"
} ],
"description": "The status of the vaccination protocol (i.e. should this count)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status"
}
},
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatus",
"condition": [ "ele-1" ],
"comment": "May need to differentiate between status declarations by a provider vs. a CDS engine.",
"base": {
"max": "1",
"min": 1,
"path": "Immunization.vaccinationProtocol.doseStatus"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.doseStatus.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatus.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.vaccinationProtocol.doseStatus.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccinationProtocol.doseStatus.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.doseStatus.coding",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 0,
"definition": "A reference to a code defined by a terminology system.",
"short": "Code defined by a terminology system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6",
"identity": "v2"
}, {
"map": "CV",
"identity": "rim"
}, {
"map": "fhir:Coding rdfs:subClassOf dt:CDCoding",
"identity": "orim"
}, {
"map": "C*E.1-8, C*E.10-22",
"identity": "v2"
}, {
"map": "union(., ./translation)",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding",
"identity": "orim"
} ],
"type": [ {
"code": "Coding"
} ],
"max": "*",
"id": "Immunization.vaccinationProtocol.doseStatus.coding",
"condition": [ "ele-1" ],
"comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.",
"base": {
"max": "*",
"min": 0,
"path": "CodeableConcept.coding"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.doseStatus.coding.id",
"min": 0,
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"short": "xml:id (or equivalent in JSON)",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"type": [ {
"code": "string"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatus.coding.id",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Element.id"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (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')])",
"severity": "error",
"expression": "extension.exists() != value.exists()"
} ],
"path": "Immunization.vaccinationProtocol.doseStatus.coding.extension",
"min": 0,
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order 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.",
"short": "Additional Content defined by implementations",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "N/A",
"identity": "rim"
} ],
"slicing": {
"rules": "open",
"description": "Extensions are always sliced by (at least) url",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
},
"type": [ {
"code": "Extension"
} ],
"alias": [ "extensions", "user content" ],
"max": "*",
"id": "Immunization.vaccinationProtocol.doseStatus.coding.extension",
"condition": [ "ele-1" ],
"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": "Element.extension"
}
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.doseStatus.coding.system",
"requirements": "Need to be unambiguous about the source of the definition of the symbol.",
"min": 1,
"definition": "The identification of the code system that defines the meaning of the symbol in the code.",
"short": "Identity of the terminology system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.3",
"identity": "v2"
}, {
"map": "./codeSystem",
"identity": "rim"
}, {
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem",
"identity": "orim"
} ],
"type": [ {
"code": "uri"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatus.coding.system",
"condition": [ "ele-1" ],
"comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.system"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.doseStatus.coding.version",
"min": 0,
"definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.",
"short": "Version of the system - if relevant",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.7",
"identity": "v2"
}, {
"map": "./codeSystemVersion",
"identity": "rim"
}, {
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatus.coding.version",
"condition": [ "ele-1" ],
"comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.version"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.doseStatus.coding.code",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).",
"short": "Symbol in syntax defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.1",
"identity": "v2"
}, {
"map": "./code",
"identity": "rim"
}, {
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code",
"identity": "orim"
} ],
"type": [ {
"code": "code"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatus.coding.code",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.code"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.doseStatus.coding.display",
"requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min": 1,
"definition": "A representation of the meaning of the code in the system, following the rules of the system.",
"short": "Representation defined by the system",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.2 - but note this is not well followed",
"identity": "v2"
}, {
"map": "CV.displayName",
"identity": "rim"
}, {
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatus.coding.display",
"condition": [ "ele-1" ],
"comment": "Note that FHIR strings may not exceed 1MB in size",
"base": {
"max": "1",
"min": 0,
"path": "Coding.display"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.doseStatus.coding.userSelected",
"requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.",
"min": 0,
"definition": "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"short": "If this coding was chosen directly by the user",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "Sometimes implied by being first",
"identity": "v2"
}, {
"map": "CD.codingRationale",
"identity": "rim"
}, {
"map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]",
"identity": "orim"
} ],
"type": [ {
"code": "boolean"
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatus.coding.userSelected",
"condition": [ "ele-1" ],
"comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.",
"base": {
"max": "1",
"min": 0,
"path": "Coding.userSelected"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.doseStatus.text",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"short": "Plain text representation of the concept",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "C*E.9. But note many systems use C*E.2 for this",
"identity": "v2"
}, {
"map": "./originalText[mediaType/code=\"text/plain\"]/data",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText",
"identity": "orim"
} ],
"type": [ {
"code": "string"
} ],
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ],
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatus.text",
"condition": [ "ele-1" ],
"comment": "Very often the text is the same as a displayName of one of the codings.",
"base": {
"max": "1",
"min": 0,
"path": "CodeableConcept.text"
},
"isSummary": true
}, {
"constraint": [ {
"key": "ele-1",
"human": "All FHIR elements must have a @value or children",
"xpath": "@value|f:*|h:div",
"severity": "error",
"expression": "hasValue() | (children().count() > id.count())"
} ],
"path": "Immunization.vaccinationProtocol.doseStatusReason",
"min": 0,
"definition": "Provides an explanation as to why an immunization event should or should not count against the protocol.",
"short": "Why dose does (not) count",
"mapping": [ {
"map": "n/a",
"identity": "rim"
}, {
"map": "CE/CNE/CWE",
"identity": "v2"
}, {
"map": "CD",
"identity": "rim"
}, {
"map": "fhir:CodeableConcept rdfs:subClassOf dt:CD",
"identity": "orim"
}, {
"map": ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].playedRole[classCode=INGR].scopedRole.scoper[classCode=MMAT].playedRole[classCode=HLTHCHRT].participation[typeCode=SBJ].observation[classCode=OBS].reasonCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccinationProtocolDoseStatusReason"
} ],
"description": "The reason for the determining if a vaccination should count or why vaccination should not count.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status-reason"
}
},
"max": "1",
"id": "Immunization.vaccinationProtocol.doseStatusReason",
"condition": [ "ele-1" ],
"comment": "Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.",
"base": {
"max": "1",
"min": 0,
"path": "Immunization.vaccinationProtocol.doseStatusReason"
}
} ]
},
"status": "draft",
"id": "a59357fb-70e8-46a5-888d-3ae2923a488b",
"kind": "resource",
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-DCH-Immunization-1",
"version": "1.2.0",
"differential": {
"element": [ {
"id": "Immunization.extension",
"path": "Immunization.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Immunization.extension:parentPresent",
"max": "1",
"path": "Immunization.extension",
"type": [ {
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1"
} ],
"sliceName": "parentPresent"
}, {
"id": "Immunization.extension:parentPresent.url",
"path": "Immunization.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-ParentPresent-1"
}, {
"id": "Immunization.extension:recordedDate",
"max": "1",
"path": "Immunization.extension",
"type": [ {
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1"
} ],
"short": "The date that the Vaccination was recorded",
"sliceName": "recordedDate"
}, {
"id": "Immunization.extension:recordedDate.url",
"path": "Immunization.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-DateRecorded-1"
}, {
"id": "Immunization.extension:vaccinationProcedure",
"max": "1",
"min": 1,
"path": "Immunization.extension",
"type": [ {
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1"
} ],
"sliceName": "vaccinationProcedure"
}, {
"id": "Immunization.extension:vaccinationProcedure.url",
"path": "Immunization.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-VaccinationProcedure-1"
}, {
"id": "Immunization.identifier.system",
"min": 1,
"path": "Immunization.identifier.system"
}, {
"id": "Immunization.identifier.value",
"min": 1,
"path": "Immunization.identifier.value"
}, {
"id": "Immunization.identifier.assigner",
"path": "Immunization.identifier.assigner",
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1"
} ]
}, {
"id": "Immunization.status",
"path": "Immunization.status",
"short": "completed",
"fixedCode": "completed"
}, {
"id": "Immunization.notGiven",
"path": "Immunization.notGiven",
"fixedBoolean": false
}, {
"id": "Immunization.vaccineCode",
"path": "Immunization.vaccineCode",
"binding": {
"strength": "required",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "VaccineCode"
} ],
"valueSetReference": {
"reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-VaccineCode-1"
}
}
}, {
"id": "Immunization.vaccineCode.coding.system",
"min": 1,
"path": "Immunization.vaccineCode.coding.system",
"fixedUri": "http://snomed.info/sct"
}, {
"id": "Immunization.vaccineCode.coding.code",
"min": 1,
"path": "Immunization.vaccineCode.coding.code"
}, {
"id": "Immunization.vaccineCode.coding.display",
"min": 1,
"path": "Immunization.vaccineCode.coding.display",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ]
}, {
"id": "Immunization.patient",
"path": "Immunization.patient",
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-DCH-Patient-1"
} ]
}, {
"id": "Immunization.patient.reference",
"min": 1,
"path": "Immunization.patient.reference"
}, {
"id": "Immunization.encounter",
"min": 1,
"path": "Immunization.encounter",
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-DCH-Encounter-1"
} ]
}, {
"id": "Immunization.encounter.reference",
"min": 1,
"path": "Immunization.encounter.reference"
}, {
"id": "Immunization.date",
"path": "Immunization.date",
"definition": "The date on which the vaccination intervention was carried out or was meant to be administered."
}, {
"id": "Immunization.primarySource",
"path": "Immunization.primarySource",
"defaultValueBoolean": true
}, {
"id": "Immunization.location",
"min": 1,
"path": "Immunization.location",
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Location-1"
} ]
}, {
"id": "Immunization.location.reference",
"min": 1,
"path": "Immunization.location.reference"
}, {
"id": "Immunization.manufacturer",
"path": "Immunization.manufacturer",
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1"
} ]
}, {
"id": "Immunization.site",
"path": "Immunization.site",
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationSite"
} ],
"valueSetReference": {
"reference": "https://fhir.nhs.uk/STU3/ValueSet/DCH-ImmunisationSite-1"
}
}
}, {
"id": "Immunization.site.coding",
"max": "1",
"path": "Immunization.site.coding"
}, {
"id": "Immunization.site.coding.extension",
"path": "Immunization.site.coding.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Immunization.site.coding.extension:snomedCTDescriptionID",
"max": "1",
"path": "Immunization.site.coding.extension",
"type": [ {
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
} ],
"short": "The SNOMED CT Description ID for the display",
"sliceName": "snomedCTDescriptionID",
"definition": "The SNOMED CT Description ID for the display."
}, {
"id": "Immunization.site.coding.extension:snomedCTDescriptionID.url",
"path": "Immunization.site.coding.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
}, {
"id": "Immunization.site.coding.system",
"min": 1,
"path": "Immunization.site.coding.system",
"fixedUri": "http://snomed.info/sct"
}, {
"id": "Immunization.site.coding.code",
"min": 1,
"path": "Immunization.site.coding.code"
}, {
"id": "Immunization.site.coding.display",
"min": 1,
"path": "Immunization.site.coding.display",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ]
}, {
"id": "Immunization.route",
"path": "Immunization.route",
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationRoute"
} ],
"valueSetReference": {
"reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-MedicationDosageRoute-1"
}
}
}, {
"id": "Immunization.route.coding",
"max": "1",
"path": "Immunization.route.coding"
}, {
"id": "Immunization.route.coding.extension",
"path": "Immunization.route.coding.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Immunization.route.coding.extension:snomedCTDescriptionID",
"max": "1",
"path": "Immunization.route.coding.extension",
"type": [ {
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
} ],
"short": "The SNOMED CT Description ID for the display",
"sliceName": "snomedCTDescriptionID",
"definition": "The SNOMED CT Description ID for the display."
}, {
"id": "Immunization.route.coding.extension:snomedCTDescriptionID.url",
"path": "Immunization.route.coding.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
}, {
"id": "Immunization.route.coding.system",
"min": 1,
"path": "Immunization.route.coding.system",
"fixedUri": "http://snomed.info/sct"
}, {
"id": "Immunization.route.coding.code",
"min": 1,
"path": "Immunization.route.coding.code"
}, {
"id": "Immunization.route.coding.display",
"min": 1,
"path": "Immunization.route.coding.display",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ]
}, {
"id": "Immunization.doseQuantity.unit",
"path": "Immunization.doseQuantity.unit",
"short": "Units of measure (from DM+D)",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ]
}, {
"id": "Immunization.practitioner",
"max": "1",
"min": 1,
"path": "Immunization.practitioner"
}, {
"id": "Immunization.practitioner.actor",
"path": "Immunization.practitioner.actor",
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-DCH-Practitioner-1"
} ]
}, {
"id": "Immunization.practitioner.actor.reference",
"min": 1,
"path": "Immunization.practitioner.actor.reference"
}, {
"id": "Immunization.note.author[x]",
"path": "Immunization.note.author[x]",
"type": [ {
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}, {
"code": "string"
}, {
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1"
}, {
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1"
} ]
}, {
"id": "Immunization.explanation.reason",
"path": "Immunization.explanation.reason",
"binding": {
"strength": "example",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "ImmunizationReason"
} ],
"valueSetReference": {
"reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-ImmunizationExplanationReason-1"
}
}
}, {
"id": "Immunization.explanation.reason.coding.system",
"min": 1,
"path": "Immunization.explanation.reason.coding.system",
"fixedUri": "http://snomed.info/sct"
}, {
"id": "Immunization.explanation.reason.coding.code",
"min": 1,
"path": "Immunization.explanation.reason.coding.code"
}, {
"id": "Immunization.explanation.reason.coding.display",
"min": 1,
"path": "Immunization.explanation.reason.coding.display",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ]
}, {
"id": "Immunization.explanation.reasonNotGiven",
"path": "Immunization.explanation.reasonNotGiven",
"binding": {
"strength": "extensible",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NoImmunizationReason"
} ],
"valueSetReference": {
"reference": "https://fhir.nhs.uk/STU3/ValueSet/DCH-ReasonNotAdminsitered-1"
}
}
}, {
"id": "Immunization.explanation.reasonNotGiven.coding.system",
"min": 1,
"path": "Immunization.explanation.reasonNotGiven.coding.system",
"fixedUri": "http://snomed.info/sct"
}, {
"id": "Immunization.explanation.reasonNotGiven.coding.code",
"min": 1,
"path": "Immunization.explanation.reasonNotGiven.coding.code"
}, {
"id": "Immunization.explanation.reasonNotGiven.coding.display",
"min": 1,
"path": "Immunization.explanation.reasonNotGiven.coding.display",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ]
}, {
"id": "Immunization.reaction.detail",
"path": "Immunization.reaction.detail",
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Observation-1"
} ]
}, {
"id": "Immunization.vaccinationProtocol.doseSequence",
"min": 1,
"path": "Immunization.vaccinationProtocol.doseSequence"
}, {
"id": "Immunization.vaccinationProtocol.authority",
"path": "Immunization.vaccinationProtocol.authority",
"type": [ {
"code": "Reference",
"targetProfile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Organization-1"
} ]
}, {
"id": "Immunization.vaccinationProtocol.targetDisease.coding",
"path": "Immunization.vaccinationProtocol.targetDisease.coding",
"slicing": {
"rules": "open",
"ordered": false,
"discriminator": [ {
"path": "system",
"type": "value"
} ]
}
}, {
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT",
"max": "1",
"path": "Immunization.vaccinationProtocol.targetDisease.coding",
"sliceName": "snomedCT"
}, {
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.extension",
"path": "Immunization.vaccinationProtocol.targetDisease.coding.extension",
"slicing": {
"rules": "open",
"discriminator": [ {
"path": "url",
"type": "value"
} ]
}
}, {
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.extension:snomedCTDescriptionID",
"path": "Immunization.vaccinationProtocol.targetDisease.coding.extension",
"type": [ {
"code": "Extension",
"profile": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
} ],
"sliceName": "snomedCTDescriptionID"
}, {
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.extension:snomedCTDescriptionID.url",
"path": "Immunization.vaccinationProtocol.targetDisease.coding.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
}, {
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.system",
"min": 1,
"path": "Immunization.vaccinationProtocol.targetDisease.coding.system",
"fixedUri": "http://snomed.info/sct"
}, {
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.version",
"max": "0",
"path": "Immunization.vaccinationProtocol.targetDisease.coding.version"
}, {
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.code",
"min": 1,
"path": "Immunization.vaccinationProtocol.targetDisease.coding.code"
}, {
"id": "Immunization.vaccinationProtocol.targetDisease.coding:snomedCT.display",
"min": 1,
"path": "Immunization.vaccinationProtocol.targetDisease.coding.display",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ]
}, {
"id": "Immunization.vaccinationProtocol.doseStatus.coding.system",
"min": 1,
"path": "Immunization.vaccinationProtocol.doseStatus.coding.system"
}, {
"id": "Immunization.vaccinationProtocol.doseStatus.coding.code",
"min": 1,
"path": "Immunization.vaccinationProtocol.doseStatus.coding.code"
}, {
"id": "Immunization.vaccinationProtocol.doseStatus.coding.display",
"min": 1,
"path": "Immunization.vaccinationProtocol.doseStatus.coding.display",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
} ]
} ]
},
"contact": [ {
"name": "Interoperability Team",
"telecom": [ {
"use": "work",
"value": "interoperabilityteam@nhs.net",
"system": "email"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Immunization"
}