US-Core CI Build
This page is part of the US Core (v0.0.0: STU1 Ballot 1) based on FHIR v1.8.0. The current version which supercedes this version is 5.0.1. For a full list of available versions, see the Directory of published versions 
{
"resourceType" : "StructureDefinition",
"id" : "us-core-immunization",
"text" : {
"status" : "generated",
"div" : "<div xmlns="http://www.w3.org/1999/xhtml"><p><b>Generated Narrative with Details</b></p><p><b>url</b>: <a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization">http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization</a></p><p><b>name</b>: US Core Immunization Profile</p><p><b>status</b>: DRAFT</p><p><b>date</b>: 01/08/2016</p><p><b>publisher</b>: Health Level Seven International (FHIR-Infrastructure)</p><p><b>contact</b>: </p><p><b>url</b>: <a href="http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization">http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization</a></p><p><b>name</b>: US Core Immunization Profile</p><p><b>status</b>: DRAFT</p><p><b>publisher</b>: Health Level Seven International (FHIR-Infrastructure)</p><p><b>contact</b>: </p><p><b>date</b>: 01/08/2016</p><blockquote><p><b>mapping</b></p><p><b>identity</b>: quick</p><p><b>uri</b>: <a href="http://wiki.siframework.org/CQF">http://wiki.siframework.org/CQF</a></p><p><b>name</b>: Quality Improvement and Clinical Knowledge (QUICK)</p></blockquote><blockquote><p><b>mapping</b></p><p><b>identity</b>: v2</p><p><b>uri</b>: <a href="http://hl7.org/v2">http://hl7.org/v2</a></p><p><b>name</b>: HL7 v2 Mapping</p></blockquote><blockquote><p><b>mapping</b></p><p><b>identity</b>: rim</p><p><b>uri</b>: <a href="http://hl7.org/v3">http://hl7.org/v3</a></p><p><b>name</b>: RIM Mapping</p></blockquote><blockquote><p><b>mapping</b></p><p><b>identity</b>: w5</p><p><b>uri</b>: <a href="http://hl7.org/fhir/w5">http://hl7.org/fhir/w5</a></p><p><b>name</b>: W5 Mapping</p></blockquote><blockquote><p><b>mapping</b></p><p><b>identity</b>: cda</p><p><b>uri</b>: <a href="http://hl7.org/v3/cda">http://hl7.org/v3/cda</a></p><p><b>name</b>: CDA (R2)</p></blockquote><p><b>kind</b>: RESOURCE</p><p><b>abstract</b>: false</p><p><b>type</b>: Immunization</p><p><b>baseDefinition</b>: <a href="http://hl7.org/fhir/StructureDefinition/Immunization">http://hl7.org/fhir/StructureDefinition/Immunization</a></p><p><b>derivation</b>: CONSTRAINT</p><h3>Snapshots</h3><table class="grid"><tr><td>-</td><td><b>Element</b></td></tr><tr><td>*</td><td>todo-bundle</td></tr></table><h3>Differentials</h3><table class="grid"><tr><td>-</td><td><b>Element</b></td></tr><tr><td>*</td><td>todo-bundle</td></tr></table></div>"
},
"url" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-immunization",
"name" : "US Core Immunization Profile",
"status" : "draft",
"publisher" : "Health Level Seven International (FHIR-Infrastructure)",
"contact" : [
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.healthit.gov"
}
]
}
],
"date" : "2016-08-01",
"mapping" : [
{
"identity" : "quick",
"uri" : "http://wiki.siframework.org/CQF",
"name" : "Quality Improvement and Clinical Knowledge (QUICK)"
},
{
"identity" : "v2",
"uri" : "http://hl7.org/v2",
"name" : "HL7 v2 Mapping"
},
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
},
{
"identity" : "w5",
"uri" : "http://hl7.org/fhir/w5",
"name" : "W5 Mapping"
},
{
"identity" : "cda",
"uri" : "http://hl7.org/v3/cda",
"name" : "CDA (R2)"
}
],
"kind" : "resource",
"abstract" : false,
"type" : "Immunization",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Immunization",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "Immunization:uscoreimmunization",
"path" : "Immunization",
"sliceName" : "USCoreImmunization",
"short" : "US Core Immunization Profile",
"definition" : "The US Core Immunization Profile is based upon the core FHIR Immunization Resource and created to meet the 2015 Edition Common Clinical Data Set 'Immunizations' requirements.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Immunization",
"min" : 0,
"max" : "*"
},
"constraint" : [
{
"key" : "dom-2",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression" : "contained.contained.empty()",
"xpath" : "not(parent::f:contained and f:contained)",
"source" : "DomainResource"
},
{
"key" : "dom-1",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression" : "contained.text.empty()",
"xpath" : "not(parent::f:contained and f:text)",
"source" : "DomainResource"
},
{
"key" : "dom-4",
"severity" : "error",
"human" : "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression" : "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath" : "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source" : "DomainResource"
},
{
"key" : "dom-3",
"severity" : "error",
"human" : "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression" : "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath" : "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source" : "DomainResource"
},
{
"key" : "imm-2",
"severity" : "error",
"human" : "If immunization was administered (wasNotGiven=false) then explanation.reasonNotGiven SHALL be absent.",
"expression" : "(wasNotGiven = true) or explanation.reasonNotGiven.empty()",
"xpath" : "not(f:wasNotGiven/@value=false() and exists(f:explanation/f:reasonNotGiven))",
"source" : "Immunization"
},
{
"key" : "imm-1",
"severity" : "error",
"human" : "If immunization was not administered (wasNotGiven=true) then there SHALL be no reaction nor explanation.reason present",
"expression" : "(wasNotGiven = true).not() or (reaction.empty() and explanation.reason.empty())",
"xpath" : "not(f:wasNotGiven/@value=true() and (count(f:reaction) > 0 or exists(f:explanation/f:reason)))",
"source" : "Immunization"
}
],
"mustSupport" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "v2",
"map" : "VXU_V04"
},
{
"identity" : "rim",
"map" : "SubstanceAdministration"
},
{
"identity" : "w5",
"map" : "clinical.medication"
},
{
"identity" : "quick",
"map" : "ImmunizationPerformanceOccurrence"
}
]
},
{
"id" : "Immunization:uscoreimmunization.id",
"path" : "Immunization.id",
"short" : "Logical id of this artifact",
"definition" : "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comments" : "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "id"
}
],
"isSummary" : true
},
{
"id" : "Immunization:uscoreimmunization.meta",
"path" : "Immunization.meta",
"short" : "Metadata about the resource",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.meta",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Meta"
}
],
"isSummary" : true
},
{
"id" : "Immunization:uscoreimmunization.implicitRules",
"path" : "Immunization.implicitRules",
"short" : "A set of rules under which this content was created",
"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.",
"comments" : "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 as much as possible.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"isModifier" : true,
"isSummary" : true
},
{
"id" : "Immunization:uscoreimmunization.language",
"path" : "Immunization.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"comments" : "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).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/all-languages"
}
}
],
"strength" : "extensible",
"description" : "A human language.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/languages"
}
}
},
{
"id" : "Immunization:uscoreimmunization.text",
"path" : "Immunization.text",
"short" : "Text summary of the resource, for human interpretation",
"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.",
"comments" : "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.",
"alias" : [
"narrative",
"html",
"xhtml",
"display"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Narrative"
}
],
"condition" : [
"dom-1"
],
"mapping" : [
{
"identity" : "rim",
"map" : "Act.text?"
}
]
},
{
"id" : "Immunization:uscoreimmunization.contained",
"path" : "Immunization.contained",
"short" : "Contained, inline Resources",
"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.",
"comments" : "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.",
"alias" : [
"inline resources",
"anonymous resources",
"contained resources"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Resource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Immunization:uscoreimmunization.extension",
"path" : "Immunization.extension",
"short" : "Additional Content defined by implementations",
"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.",
"comments" : "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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Immunization:uscoreimmunization.modifierExtension",
"path" : "Immunization.modifierExtension",
"short" : "Extensions that cannot be ignored",
"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.",
"comments" : "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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Immunization:uscoreimmunization.identifier",
"path" : "Immunization.identifier",
"short" : "Business identifier",
"definition" : "A unique identifier assigned to this immunization record.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Immunization.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : ".id"
},
{
"identity" : "cda",
"map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/id"
},
{
"identity" : "w5",
"map" : "id"
}
]
},
{
"id" : "Immunization:uscoreimmunization.status",
"path" : "Immunization.status",
"short" : "completed | entered-in-error",
"definition" : "Indicates the current status of the vaccination event.",
"comments" : "Will generally be set to show that the immunization has been completed.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Immunization.status",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"mustSupport" : true,
"isModifier" : true,
"isSummary" : false,
"binding" : {
"strength" : "required",
"description" : "Constrained list of immunizaiotn status",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/us/core/ValueSet/us-core-immunization-status"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "statusCode"
},
{
"identity" : "w5",
"map" : "status"
}
]
},
{
"id" : "Immunization:uscoreimmunization.date",
"path" : "Immunization.date",
"short" : "Vaccination administration date",
"definition" : "Date vaccine administered or was to be administered.",
"comments" : "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.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Immunization.date",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"mustSupport" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-3"
},
{
"identity" : "rim",
"map" : ".effectiveTime"
},
{
"identity" : "cda",
"map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/effectiveTime/value"
},
{
"identity" : "w5",
"map" : "when.init"
},
{
"identity" : "quick",
"map" : "performanceTime"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccineCode",
"path" : "Immunization.vaccineCode",
"short" : "Vaccine Product Type (bind to CVX)",
"definition" : "Vaccine that was administered or was to be administered.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Immunization.vaccineCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"mustSupport" : true,
"isSummary" : false,
"binding" : {
"strength" : "example",
"description" : "The code for vaccine product administered",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/vaccine-code"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-5"
},
{
"identity" : "rim",
"map" : ".code"
},
{
"identity" : "cda",
"map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/realmCode/code"
},
{
"identity" : "w5",
"map" : "what"
},
{
"identity" : "quick",
"map" : "vaccine"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccineCode.id",
"path" : "Immunization.vaccineCode.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccineCode.extension",
"path" : "Immunization.vaccineCode.extension",
"short" : "Additional Content defined by implementations",
"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.",
"comments" : "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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccineCode.coding",
"path" : "Immunization.vaccineCode.coding",
"slicing" : {
"discriminator" : [
"code"
],
"rules" : "open"
},
"short" : "Code defined by a terminology system",
"definition" : "A reference to a code defined by a terminology system.",
"comments" : "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 labelled as UserSelected = true.",
"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,
"max" : "*",
"base" : {
"path" : "CodeableConcept.coding",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Coding"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.1-8, C*E.10-22"
},
{
"identity" : "rim",
"map" : "union(., ./translation)"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccineCode.coding:uscorevaccinecodes",
"path" : "Immunization.vaccineCode.coding",
"sliceName" : "USCoreVaccineCodes",
"short" : "Code defined by a terminology system",
"definition" : "A reference to a code defined by a terminology system.",
"comments" : "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 labelled as UserSelected = true.",
"requirements" : "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CodeableConcept.coding",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Coding"
}
],
"mustSupport" : true,
"isSummary" : false,
"binding" : {
"strength" : "required",
"description" : "The CVX (vaccine administered) code system",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/us/core/ValueSet/us-core-cvx"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.1-8, C*E.10-22"
},
{
"identity" : "rim",
"map" : "union(., ./translation)"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
},
{
"identity" : "quick",
"map" : "vaccine"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccineCode.coding",
"path" : "Immunization.vaccineCode.coding",
"short" : "Code defined by a terminology system",
"definition" : "A reference to a code defined by a terminology system.",
"comments" : "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 labelled as UserSelected = true.",
"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,
"max" : "1",
"base" : {
"path" : "CodeableConcept.coding",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Coding"
}
],
"mustSupport" : true,
"isSummary" : false,
"binding" : {
"strength" : "required",
"description" : "NDC codes to identify vaccines",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/us/core/ValueSet/us-core-ndc-vaccine-codes"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.1-8, C*E.10-22"
},
{
"identity" : "rim",
"map" : "union(., ./translation)"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
},
{
"identity" : "quick",
"map" : "vaccine"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccineCode.text",
"path" : "Immunization.vaccineCode.text",
"short" : "Plain text representation of the concept",
"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.",
"comments" : "Very often the text is the same as a displayName of one of the codings.",
"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,
"max" : "1",
"base" : {
"path" : "CodeableConcept.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "v2",
"map" : "C*E.9. But note many systems use C*E.2 for this"
},
{
"identity" : "rim",
"map" : "./originalText[mediaType/code="text/plain"]/data"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
}
]
},
{
"id" : "Immunization:uscoreimmunization.patient",
"path" : "Immunization.patient",
"short" : "Who was immunized",
"definition" : "The patient who either received or did not receive the immunization.",
"alias" : [
"Patient"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "Immunization.patient",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
}
],
"mustSupport" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : ".partipication[ttypeCode=].role"
},
{
"identity" : "w5",
"map" : "who.focus"
},
{
"identity" : "quick",
"map" : "subject"
}
]
},
{
"id" : "Immunization:uscoreimmunization.wasNotGiven",
"path" : "Immunization.wasNotGiven",
"short" : "Flag for whether immunization was given",
"definition" : "Indicates if the vaccination was or was not given.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Immunization.wasNotGiven",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"mustSupport" : true,
"isModifier" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "[actionNegationInd=true].reasonCode"
},
{
"identity" : "w5",
"map" : "status"
}
]
},
{
"id" : "Immunization:uscoreimmunization.primarySource",
"path" : "Immunization.primarySource",
"short" : "Indicates context the data was recorded in",
"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.",
"comments" : "Reflects the “reliability” of the content.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Immunization.primarySource",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"mustSupport" : true,
"isSummary" : false,
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-9"
},
{
"identity" : "rim",
"map" : "immunization.uncertaintycode (if primary source=false, uncertainty=U)"
},
{
"identity" : "w5",
"map" : "who.source"
},
{
"identity" : "quick",
"map" : "reported"
}
]
},
{
"id" : "Immunization:uscoreimmunization.reportOrigin",
"path" : "Immunization.reportOrigin",
"short" : "Indicates the source of a secondarily reported record",
"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.",
"comments" : "Should not be populated if primarySource = True, will not be required even if primarySource = False.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.reportOrigin",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "example",
"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"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-9"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported) .participation[typeCode=INF].role[classCode=LIC] (this syntax for health care professional) .participation[typeCode=INF].role[classCode=PRS] (this syntax for family member)"
},
{
"identity" : "w5",
"map" : "who.source"
}
]
},
{
"id" : "Immunization:uscoreimmunization.performer",
"path" : "Immunization.performer",
"short" : "Who administered vaccine",
"definition" : "Clinician who administered the vaccine.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.performer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-10"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=PRF].COCT_MT090102UV"
},
{
"identity" : "cda",
"map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/performer/assignedEntity/assignedPerson/name"
},
{
"identity" : "w5",
"map" : "who.actor"
}
]
},
{
"id" : "Immunization:uscoreimmunization.requester",
"path" : "Immunization.requester",
"short" : "Who ordered vaccination",
"definition" : "Clinician who ordered the vaccination.",
"comments" : "Other participants - delegate to Provenance resource.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.requester",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping" : [
{
"identity" : "v2",
"map" : "ORC-12"
},
{
"identity" : "rim",
"map" : "outboundRelationship.target[classCode=SBADM].participation[typeCode=AUT].COCT_MT090102UV"
},
{
"identity" : "w5",
"map" : "who.cause"
}
]
},
{
"id" : "Immunization:uscoreimmunization.encounter",
"path" : "Immunization.encounter",
"short" : "Encounter administered as part of",
"definition" : "The visit or admission or other contact between patient and health care provider the immunization was performed as part of.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.encounter",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Encounter"
}
],
"mapping" : [
{
"identity" : "v2",
"map" : "PV1-19"
},
{
"identity" : "rim",
"map" : "component->EncounterEvent"
},
{
"identity" : "w5",
"map" : "context"
}
]
},
{
"id" : "Immunization:uscoreimmunization.manufacturer",
"path" : "Immunization.manufacturer",
"short" : "Vaccine manufacturer",
"definition" : "Name of vaccine manufacturer.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.manufacturer",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-17"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=ORG]"
},
{
"identity" : "cda",
"map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacuturerOrganization/name"
}
]
},
{
"id" : "Immunization:uscoreimmunization.location",
"path" : "Immunization.location",
"short" : "Where vaccination occurred",
"definition" : "The service delivery location where the vaccine administration occurred.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.location",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Location"
}
],
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-27 (or RXA-11, deprecated as of v2.7)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=LOC].COCT_MT240000UV"
},
{
"identity" : "w5",
"map" : "where"
}
]
},
{
"id" : "Immunization:uscoreimmunization.lotNumber",
"path" : "Immunization.lotNumber",
"short" : "Vaccine lot number",
"definition" : "Lot number of the vaccine product.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.lotNumber",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-15"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].id"
},
{
"identity" : "cda",
"map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/consumable/manfacturedProduct/manufacturedMaterial/lotNumberText"
}
]
},
{
"id" : "Immunization:uscoreimmunization.expirationDate",
"path" : "Immunization.expirationDate",
"short" : "Vaccine expiration date",
"definition" : "Date vaccine batch expires.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.expirationDate",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "date"
}
],
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-16"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=CSM].role[classCode=INST].scopedRole.scoper[classCode=MMAT].expirationTime"
}
]
},
{
"id" : "Immunization:uscoreimmunization.site",
"path" : "Immunization.site",
"short" : "Body site vaccine was administered",
"definition" : "Body site where vaccine was administered.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.site",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "example",
"description" : "The site at which the vaccine was administered",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/immunization-site"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "RXR-2"
},
{
"identity" : "rim",
"map" : "observation.targetSiteCode"
},
{
"identity" : "cda",
"map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/approachSiteCode/code"
}
]
},
{
"id" : "Immunization:uscoreimmunization.route",
"path" : "Immunization.route",
"short" : "How vaccine entered body",
"definition" : "The path by which the vaccine product is taken into the body.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.route",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "example",
"description" : "The route by which the vaccine was administered",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/immunization-route"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "RXR-1"
},
{
"identity" : "rim",
"map" : ".routeCode"
},
{
"identity" : "cda",
"map" : "ClinicalDocument/component/StructuredBody/component/section/entry/substanceAdministration/routeCode/code"
}
]
},
{
"id" : "Immunization:uscoreimmunization.doseQuantity",
"path" : "Immunization.doseQuantity",
"short" : "Amount of vaccine administered",
"definition" : "The quantity of vaccine product that was administered.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.doseQuantity",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Quantity",
"profile" : "http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
}
],
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-6 / RXA-7.1"
},
{
"identity" : "rim",
"map" : ".doseQuantity"
}
]
},
{
"id" : "Immunization:uscoreimmunization.note",
"path" : "Immunization.note",
"short" : "Vaccination notes",
"definition" : "Extra information about the immunization that is not conveyed by the other attributes.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Immunization.note",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Annotation"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "note"
}
]
},
{
"id" : "Immunization:uscoreimmunization.explanation",
"path" : "Immunization.explanation",
"short" : "Administration/non-administration reasons",
"definition" : "Reasons why a vaccine was or was not administered.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.explanation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "children().count() > id.count()",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Immunization:uscoreimmunization.explanation.id",
"path" : "Immunization.explanation.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Immunization:uscoreimmunization.explanation.extension",
"path" : "Immunization.explanation.extension",
"short" : "Additional Content defined by implementations",
"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.",
"comments" : "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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Immunization:uscoreimmunization.explanation.modifierExtension",
"path" : "Immunization.explanation.modifierExtension",
"short" : "Extensions that cannot be ignored",
"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.",
"comments" : "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.",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Immunization:uscoreimmunization.explanation.reason",
"path" : "Immunization.explanation.reason",
"short" : "Why immunization occurred",
"definition" : "Reasons why a vaccine was administered.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Immunization.explanation.reason",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "example",
"description" : "The reason why a vaccine was administered",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/immunization-reason"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "[actionNegationInd=false].reasonCode"
}
]
},
{
"id" : "Immunization:uscoreimmunization.explanation.reasonNotGiven",
"path" : "Immunization.explanation.reasonNotGiven",
"short" : "Why immunization did not occur",
"definition" : "Reason why a vaccine was not administered.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Immunization.explanation.reasonNotGiven",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "example",
"description" : "The reason why a vaccine was not administered",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/no-immunization-reason"
}
},
"mapping" : [
{
"identity" : "v2",
"map" : "RXA-18"
},
{
"identity" : "rim",
"map" : "[actionNegationInd=true].reasonCode"
}
]
},
{
"id" : "Immunization:uscoreimmunization.reaction",
"path" : "Immunization.reaction",
"short" : "Details of a reaction that follows immunization",
"definition" : "Categorical data indicating that an adverse event is associated in time to an immunization.",
"comments" : "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.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Immunization.reaction",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "children().count() > id.count()",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mapping" : [
{
"identity" : "v2",
"map" : "OBX-3"
},
{
"identity" : "rim",
"map" : "Observation[classCode=obs].code"
}
]
},
{
"id" : "Immunization:uscoreimmunization.reaction.id",
"path" : "Immunization.reaction.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Immunization:uscoreimmunization.reaction.extension",
"path" : "Immunization.reaction.extension",
"short" : "Additional Content defined by implementations",
"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.",
"comments" : "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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Immunization:uscoreimmunization.reaction.modifierExtension",
"path" : "Immunization.reaction.modifierExtension",
"short" : "Extensions that cannot be ignored",
"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.",
"comments" : "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.",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Immunization:uscoreimmunization.reaction.date",
"path" : "Immunization.reaction.date",
"short" : "When reaction started",
"definition" : "Date of reaction to the immunization.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.reaction.date",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"mapping" : [
{
"identity" : "v2",
"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" : "rim",
"map" : ".effectiveTime"
}
]
},
{
"id" : "Immunization:uscoreimmunization.reaction.detail",
"path" : "Immunization.reaction.detail",
"short" : "Additional information on reaction",
"definition" : "Details of the reaction.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.reaction.detail",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Observation"
}
],
"mapping" : [
{
"identity" : "v2",
"map" : "OBX-5"
},
{
"identity" : "rim",
"map" : ".value"
}
]
},
{
"id" : "Immunization:uscoreimmunization.reaction.reported",
"path" : "Immunization.reaction.reported",
"short" : "Indicates self-reported reaction",
"definition" : "Self-reported indicator.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.reaction.reported",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"mapping" : [
{
"identity" : "v2",
"map" : "(no such concept seems to exist for allergy/adverse reaction in HL7 v2)"
},
{
"identity" : "rim",
"map" : ".participation[typeCode=INF].role[classCode=PAT] (this syntax for self-reported=true)"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccinationProtocol",
"path" : "Immunization.vaccinationProtocol",
"short" : "What protocol was followed",
"definition" : "Contains information about the protocol(s) under which the vaccine was administered.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Immunization.vaccinationProtocol",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "children().count() > id.count()",
"xpath" : "@value|f:*|h:div",
"source" : "Element"
}
],
"mapping" : [
{
"identity" : "v2",
"map" : "(HL7 v2 doesn't seem to provide for this)"
},
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=INST].target[classCode=SBADM]"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccinationProtocol.id",
"path" : "Immunization.vaccinationProtocol.id",
"representation" : [
"xmlAttr"
],
"short" : "xml:id (or equivalent in JSON)",
"definition" : "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccinationProtocol.extension",
"path" : "Immunization.vaccinationProtocol.extension",
"short" : "Additional Content defined by implementations",
"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.",
"comments" : "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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccinationProtocol.modifierExtension",
"path" : "Immunization.vaccinationProtocol.modifierExtension",
"short" : "Extensions that cannot be ignored",
"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.",
"comments" : "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.",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccinationProtocol.doseSequence",
"path" : "Immunization.vaccinationProtocol.doseSequence",
"short" : "Dose number within series",
"definition" : "Nominal position in a series.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.vaccinationProtocol.doseSequence",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "positiveInt"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].sequenceNumber"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccinationProtocol.description",
"path" : "Immunization.vaccinationProtocol.description",
"short" : "Details of vaccine protocol",
"definition" : "Contains the description about the protocol under which the vaccine was administered.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.vaccinationProtocol.description",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccinationProtocol.authority",
"path" : "Immunization.vaccinationProtocol.authority",
"short" : "Who is responsible for protocol",
"definition" : "Indicates the authority who published the protocol. E.g. ACIP.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.vaccinationProtocol.authority",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].participation[typeCode=AUT].COCT_MT090200UV"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccinationProtocol.series",
"path" : "Immunization.vaccinationProtocol.series",
"short" : "Name of vaccine series",
"definition" : "One possible path to achieve presumed immunity against a disease - within the context of an authority.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.vaccinationProtocol.series",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=INST].target[classCode=SBADM]"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccinationProtocol.seriesDoses",
"path" : "Immunization.vaccinationProtocol.seriesDoses",
"short" : "Recommended number of doses for immunity",
"definition" : "The recommended number of doses to achieve immunity.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.vaccinationProtocol.seriesDoses",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "positiveInt"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "outboundRelationship[typeCode=INST].target[classCode=SBADM].inboundRelationship[typeCode=COMP].source[classCode=SBADM].text"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccinationProtocol.targetDisease",
"path" : "Immunization.vaccinationProtocol.targetDisease",
"short" : "Disease immunized against",
"definition" : "The targeted disease.",
"min" : 1,
"max" : "*",
"base" : {
"path" : "Immunization.vaccinationProtocol.targetDisease",
"min" : 1,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "example",
"description" : "The disease target of the vaccination protocol",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-target"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "outboundRelationship.target[classCode=OBS].code"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccinationProtocol.doseStatus",
"path" : "Immunization.vaccinationProtocol.doseStatus",
"short" : "Indicates if dose counts towards immunity",
"definition" : "Indicates if the immunization event should "count" against the protocol.",
"comments" : "May need to differentiate between status declarations by a provider vs. a CDS engine.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Immunization.vaccinationProtocol.doseStatus",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "example",
"description" : "The status of the vaccination protocol (i.e. should this count)",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/vaccination-protocol-dose-status"
}
},
"mapping" : [
{
"identity" : "rim",
"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"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccinationProtocol.doseStatusReason",
"path" : "Immunization.vaccinationProtocol.doseStatusReason",
"short" : "Why dose does (not) count",
"definition" : "Provides an explanation as to why an immunization event should or should not count against the protocol.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Immunization.vaccinationProtocol.doseStatusReason",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"binding" : {
"strength" : "example",
"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"
}
},
"mapping" : [
{
"identity" : "rim",
"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"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Immunization:uscoreimmunization",
"path" : "Immunization",
"sliceName" : "USCoreImmunization",
"short" : "US Core Immunization Profile",
"definition" : "The US Core Immunization Profile is based upon the core FHIR Immunization Resource and created to meet the 2015 Edition Common Clinical Data Set 'Immunizations' requirements.",
"mustSupport" : false,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "quick",
"map" : "ImmunizationPerformanceOccurrence"
}
]
},
{
"id" : "Immunization:uscoreimmunization.status",
"path" : "Immunization.status",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"strength" : "required",
"description" : "Constrained list of immunizaiotn status",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/us/core/ValueSet/us-core-immunization-status"
}
}
},
{
"id" : "Immunization:uscoreimmunization.date",
"path" : "Immunization.date",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "dateTime"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "quick",
"map" : "performanceTime"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccineCode",
"path" : "Immunization.vaccineCode",
"short" : "Vaccine Product Type (bind to CVX)",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "CodeableConcept"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "quick",
"map" : "vaccine"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccineCode.coding:uscorevaccinecodes",
"path" : "Immunization.vaccineCode.coding",
"sliceName" : "USCoreVaccineCodes",
"slicing" : {
"discriminator" : [
"code"
],
"rules" : "open"
},
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "Coding"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"strength" : "required",
"description" : "The CVX (vaccine administered) code system",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/us/core/ValueSet/us-core-cvx"
}
},
"mapping" : [
{
"identity" : "quick",
"map" : "vaccine"
}
]
},
{
"id" : "Immunization:uscoreimmunization.vaccineCode.coding",
"path" : "Immunization.vaccineCode.coding",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "Coding"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"binding" : {
"strength" : "required",
"description" : "NDC codes to identify vaccines",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/us/core/ValueSet/us-core-ndc-vaccine-codes"
}
},
"mapping" : [
{
"identity" : "quick",
"map" : "vaccine"
}
]
},
{
"id" : "Immunization:uscoreimmunization.patient",
"path" : "Immunization.patient",
"alias" : [
"Patient"
],
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "quick",
"map" : "subject"
}
]
},
{
"id" : "Immunization:uscoreimmunization.wasNotGiven",
"path" : "Immunization.wasNotGiven",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "boolean"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false
},
{
"id" : "Immunization:uscoreimmunization.primarySource",
"path" : "Immunization.primarySource",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "boolean"
}
],
"mustSupport" : true,
"isModifier" : false,
"isSummary" : false,
"mapping" : [
{
"identity" : "quick",
"map" : "reported"
}
]
}
]
}
}
US-Core © FHIR STU3 (IG Publisher v1.8.0-10514) generated on Tue, Dec 6, 2016 16:58+1100. |
