This page is part of the International Patient Summary Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
JSON Format: StructureDefinition-patient-uv-ips
Raw json
{
"resourceType" : "StructureDefinition",
"id" : "patient-uv-ips",
"text" : {
"status" : "generated",
"div" : "<div xmlns="http://www.w3.org/1999/xhtml"><table border="0" cellpadding="0" cellspacing="0" style="border: 0px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><tr style="border: 1px #F0F0F0 solid; font-size: 11px; font-family: verdana; vertical-align: top;"><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="The logical name of the element">Name</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Information about the use of the element">Flags</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Minimum and Maximum # of times the the element can appear in the instance">Card.</a></th><th style="width: 100px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Reference to the type of the element">Type</a></th><th style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><a href="http://hl7.org/fhir/formats.html#table" title="Additional information about the element">Description & Constraints</a><span style="float: right"><a href="http://hl7.org/fhir/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/help16.png" alt="doco" style="background-color: inherit"/></a></span></th></tr><tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck1.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-patient-uv-ips-definitions.html#Patient.name" title="null">name</a><a name="Patient.name"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck10.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-patient-uv-ips-definitions.html#Patient.name.family" title="null">family</a><a name="Patient.name.family"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr style="border: 0px #F0F0F0 solid; padding:0px; vertical-align: top; background-color: white;"><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px; white-space: nowrap; background-image: url(tbl_bck00.png)" class="hierarchy"><img src="tbl_spacer.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="tbl_vjoin_end.png" alt="." style="background-color: inherit" class="hierarchy"/><img src="icon_element.gif" alt="." style="background-color: white; background-color: inherit" title="Element" class="hierarchy"/> <a href="StructureDefinition-patient-uv-ips-definitions.html#Patient.name.given" title="null">given</a><a name="Patient.name.given"> </a></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"><span style="padding-left: 3px; padding-right: 3px; color: white; background-color: red" title="This element must be supported">S</span></td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy">1..1</td><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/><td style="vertical-align: top; text-align : left; background-color: white; border: 0px #F0F0F0 solid; padding:0px 4px 0px 4px" class="hierarchy"/></tr>
<tr><td colspan="5" class="hierarchy"><br/><a href="http://hl7.org/fhir/formats.html#table" title="Legend for this format"><img src="http://hl7.org/fhir/help16.png" alt="doco" style="background-color: inherit"/> Documentation for this format</a></td></tr></table></div>"
},
"url" : "http://hl7.org/fhir/uv/ips/StructureDefinition/patient-uv-ips",
"version" : "0.1.0",
"name" : "Patient-uv-ips",
"status" : "draft",
"date" : "2018-03-21T02:43:56+11:00",
"description" : "This profile represents the constraints applied to the Patient resource by the International Patient Summary (IPS) FHIR Implementation Guide and describes the minimum expectations for the Patient resource when used in the IPS composition or in one of the referred resources.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"fhirVersion" : "3.0.1",
"kind" : "resource",
"abstract" : false,
"type" : "Patient",
"baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Patient",
"derivation" : "constraint",
"snapshot" : {
"element" : [
{
"id" : "Patient",
"path" : "Patient",
"short" : "Information about an individual or animal receiving health care services",
"definition" : "Demographics and other administrative information about an individual or animal receiving care or other health-related services.",
"alias" : [
"SubjectOfCare Client Resident"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Resource",
"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)"
},
{
"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)"
},
{
"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))"
},
{
"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))]))"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "Patient[classCode=PAT]"
},
{
"identity" : "cda",
"map" : "ClinicalDocument.recordTarget.patientRole"
},
{
"identity" : "w5",
"map" : "administrative.individual"
}
]
},
{
"id" : "Patient.id",
"path" : "Patient.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.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "id"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.meta",
"path" : "Patient.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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.implicitRules",
"path" : "Patient.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.",
"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.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.implicitRules",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.language",
"path" : "Patient.language",
"short" : "Language of the resource content",
"definition" : "The base language in which the resource is written.",
"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).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Resource.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"binding" : {
"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
}
],
"strength" : "extensible",
"description" : "A human language.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/languages"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.text",
"path" : "Patient.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.",
"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.",
"alias" : [
"narrative",
"html",
"xhtml",
"display"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "DomainResource.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Narrative"
}
],
"condition" : [
"ele-1",
"dom-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Act.text?"
}
]
},
{
"id" : "Patient.contained",
"path" : "Patient.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.",
"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.",
"alias" : [
"inline resources",
"anonymous resources",
"contained resources"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.contained",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Resource"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "Entity. Role, or Act"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.extension",
"path" : "Patient.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.modifierExtension",
"path" : "Patient.modifierExtension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "DomainResource.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"isModifier" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.identifier",
"path" : "Patient.identifier",
"short" : "An identifier for this patient",
"definition" : "An identifier for this patient.",
"requirements" : "Patients are almost always assigned specific numerical identifiers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.identifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Identifier"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"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" : "servd",
"map" : "Identifier"
},
{
"identity" : "v2",
"map" : "PID-3"
},
{
"identity" : "rim",
"map" : "id"
},
{
"identity" : "cda",
"map" : ".id"
},
{
"identity" : "w5",
"map" : "id"
}
]
},
{
"id" : "Patient.identifier.id",
"path" : "Patient.identifier.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.identifier.extension",
"path" : "Patient.identifier.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.identifier.use",
"path" : "Patient.identifier.use",
"short" : "usual | official | temp | secondary (If known)",
"definition" : "The purpose of this identifier.",
"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.",
"requirements" : "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierUse"
}
],
"strength" : "required",
"description" : "Identifies the purpose for this identifier, if known .",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Patient.identifier.type",
"path" : "Patient.identifier.type",
"short" : "Description of identifier",
"definition" : "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"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.
Where 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.",
"requirements" : "Allows users to make use of identifiers when the identifier system is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "IdentifierType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"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"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "CX.5"
},
{
"identity" : "rim",
"map" : "Role.code or implied by context"
}
]
},
{
"id" : "Patient.identifier.type.id",
"path" : "Patient.identifier.type.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.identifier.type.extension",
"path" : "Patient.identifier.type.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.identifier.type.coding",
"path" : "Patient.identifier.type.coding",
"short" : "Code defined by a terminology system",
"definition" : "A reference to a code defined by a terminology system.",
"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.",
"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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity" : "rim",
"map" : "CV"
},
{
"identity" : "orim",
"map" : "fhir:Coding rdfs:subClassOf dt:CDCoding"
},
{
"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" : "Patient.identifier.type.coding.id",
"path" : "Patient.identifier.type.coding.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.identifier.type.coding.extension",
"path" : "Patient.identifier.type.coding.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.identifier.type.coding.system",
"path" : "Patient.identifier.type.coding.system",
"short" : "Identity of the terminology system",
"definition" : "The identification of the code system that defines the meaning of the symbol in the code.",
"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.",
"requirements" : "Need to be unambiguous about the source of the definition of the symbol.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.3"
},
{
"identity" : "rim",
"map" : "./codeSystem"
},
{
"identity" : "orim",
"map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id" : "Patient.identifier.type.coding.version",
"path" : "Patient.identifier.type.coding.version",
"short" : "Version of the system - if relevant",
"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.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.version",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.7"
},
{
"identity" : "rim",
"map" : "./codeSystemVersion"
},
{
"identity" : "orim",
"map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id" : "Patient.identifier.type.coding.code",
"path" : "Patient.identifier.type.coding.code",
"short" : "Symbol in syntax defined by the system",
"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).",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Need to refer to a particular code in the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.1"
},
{
"identity" : "rim",
"map" : "./code"
},
{
"identity" : "orim",
"map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id" : "Patient.identifier.type.coding.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.identifier.type.coding.display",
"short" : "Representation defined by the system",
"definition" : "A representation of the meaning of the code in the system, following the rules of the system.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.2 - but note this is not well followed"
},
{
"identity" : "rim",
"map" : "CV.displayName"
},
{
"identity" : "orim",
"map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
}
]
},
{
"id" : "Patient.identifier.type.coding.userSelected",
"path" : "Patient.identifier.type.coding.userSelected",
"short" : "If this coding was chosen directly by the user",
"definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"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.",
"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,
"max" : "1",
"base" : {
"path" : "Coding.userSelected",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "Sometimes implied by being first"
},
{
"identity" : "rim",
"map" : "CD.codingRationale"
},
{
"identity" : "orim",
"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 ]"
}
]
},
{
"id" : "Patient.identifier.type.text",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.identifier.type.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.",
"comment" : "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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"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" : "Patient.identifier.system",
"path" : "Patient.identifier.system",
"short" : "The namespace for the identifier value",
"definition" : "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"comment" : "see http://en.wikipedia.org/wiki/Uniform_resource_identifier",
"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" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"example" : [
{
"label" : "General",
"valueUri" : "http://www.acme.com/identifiers/patient"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX.4 / EI-2-4"
},
{
"identity" : "rim",
"map" : "II.root or Role.id.root"
},
{
"identity" : "servd",
"map" : "./IdentifierType"
}
]
},
{
"id" : "Patient.identifier.value",
"path" : "Patient.identifier.value",
"short" : "The value that is unique",
"definition" : "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"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).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "123456"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX.1 / EI.1"
},
{
"identity" : "rim",
"map" : "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Patient.identifier.period",
"path" : "Patient.identifier.period",
"short" : "Time period when id is/was valid for use",
"definition" : "Time period during which identifier is/was valid for use.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "per-1",
"severity" : "error",
"human" : "If present, start SHALL have a lower value than end",
"expression" : "start.empty() or end.empty() or (start <= end)",
"xpath" : "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR"
},
{
"identity" : "rim",
"map" : "IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]"
},
{
"identity" : "v2",
"map" : "CX.7 + CX.8"
},
{
"identity" : "rim",
"map" : "Role.effectiveTime or implied by context"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Patient.identifier.period.id",
"path" : "Patient.identifier.period.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.identifier.period.extension",
"path" : "Patient.identifier.period.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.identifier.period.start",
"path" : "Patient.identifier.period.start",
"short" : "Starting time with inclusive boundary",
"definition" : "The start of the period. The boundary is inclusive.",
"comment" : "If the low element is missing, the meaning is that the low boundary is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.start",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.1"
},
{
"identity" : "rim",
"map" : "./low"
}
]
},
{
"id" : "Patient.identifier.period.end",
"path" : "Patient.identifier.period.end",
"short" : "End time with inclusive boundary, if not ongoing",
"definition" : "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
"comment" : "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.end",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"meaningWhenMissing" : "If the end of the period is missing, it means that the period is ongoing",
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.2"
},
{
"identity" : "rim",
"map" : "./high"
}
]
},
{
"id" : "Patient.identifier.assigner",
"path" : "Patient.identifier.assigner",
"short" : "Organization that issued id (may be just text)",
"definition" : "Organization that issued/manages the identifier.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Identifier.assigner",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))",
"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, '#')])"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "v2",
"map" : "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity" : "rim",
"map" : "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity" : "servd",
"map" : "./IdentifierIssuingAuthority"
}
]
},
{
"id" : "Patient.identifier.assigner.id",
"path" : "Patient.identifier.assigner.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.identifier.assigner.extension",
"path" : "Patient.identifier.assigner.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.identifier.assigner.reference",
"path" : "Patient.identifier.assigner.reference",
"short" : "Literal reference, Relative, internal or absolute URL",
"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.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.reference",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1",
"ref-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.identifier.assigner.identifier",
"path" : "Patient.identifier.assigner.identifier",
"short" : "Logical reference, when literal reference is not known",
"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.",
"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.
When 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
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.identifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"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" : "servd",
"map" : "Identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
}
]
},
{
"id" : "Patient.identifier.assigner.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.identifier.assigner.display",
"short" : "Text alternative for the resource",
"definition" : "Plain text narrative that identifies the resource in addition to the resource reference.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.active",
"path" : "Patient.active",
"short" : "Whether this patient's record is in active use",
"definition" : "Whether this patient record is in active use.",
"comment" : "Default is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient
This element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active.",
"requirements" : "Need to be able to mark a patient record as not to be used because it was created in error.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.active",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"defaultValueBoolean" : true,
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "statusCode"
},
{
"identity" : "cda",
"map" : "n/a"
},
{
"identity" : "w5",
"map" : "status"
}
]
},
{
"id" : "Patient.name",
"path" : "Patient.name",
"short" : "A name associated with the patient",
"definition" : "A name associated with the individual.",
"comment" : "A patient may have multiple names with different uses or applicable periods. For animals, the name is a "HumanName" in the sense that is assigned and used by humans and has the same patterns.",
"requirements" : "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.
The Alphabetic representation of the name SHALL be always provided",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.name",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "HumanName"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XPN"
},
{
"identity" : "rim",
"map" : "EN (actually, PN)"
},
{
"identity" : "servd",
"map" : "ProviderName"
},
{
"identity" : "v2",
"map" : "PID-5, PID-9"
},
{
"identity" : "rim",
"map" : "name"
},
{
"identity" : "cda",
"map" : ".patient.name"
}
]
},
{
"id" : "Patient.name.id",
"path" : "Patient.name.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.name.extension",
"path" : "Patient.name.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.name.use",
"path" : "Patient.name.use",
"short" : "usual | official | temp | nickname | anonymous | old | maiden",
"definition" : "Identifies the purpose for this name.",
"comment" : "This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.",
"requirements" : "Allows the appropriate name for a particular context of use to be selected from among a set of names.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "HumanName.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NameUse"
}
],
"strength" : "required",
"description" : "The use of a human name",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/name-use"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XPN.7, but often indicated by which field contains the name"
},
{
"identity" : "rim",
"map" : "unique(./use)"
},
{
"identity" : "servd",
"map" : "./NamePurpose"
}
]
},
{
"id" : "Patient.name.text",
"path" : "Patient.name.text",
"short" : "Text representation of the full name",
"definition" : "A full text representation of the name.",
"comment" : "Can provide both a text representation and structured parts.",
"requirements" : "A renderable, unencoded form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "HumanName.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "implied by XPN.11"
},
{
"identity" : "rim",
"map" : "./formatted"
}
]
},
{
"id" : "Patient.name.family",
"path" : "Patient.name.family",
"short" : "Family name (often called 'Surname')",
"definition" : "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.",
"comment" : "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).",
"alias" : [
"surname"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "HumanName.family",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XPN.1/FN.1"
},
{
"identity" : "rim",
"map" : "./part[partType = FAM]"
},
{
"identity" : "servd",
"map" : "./FamilyName"
}
]
},
{
"id" : "Patient.name.given",
"path" : "Patient.name.given",
"short" : "Given names (not always 'first'). Includes middle names",
"definition" : "Given name.",
"comment" : "If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first.",
"alias" : [
"first name",
"middle name"
],
"min" : 1,
"max" : "1",
"base" : {
"path" : "HumanName.given",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"orderMeaning" : "Given Names appear in the correct order for presenting the name",
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XPN.2 + XPN.3"
},
{
"identity" : "rim",
"map" : "./part[partType = GIV]"
},
{
"identity" : "servd",
"map" : "./GivenNames"
}
]
},
{
"id" : "Patient.name.prefix",
"path" : "Patient.name.prefix",
"short" : "Parts that come before the name",
"definition" : "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "*",
"base" : {
"path" : "HumanName.prefix",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"orderMeaning" : "Prefixes appear in the correct order for presenting the name",
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XPN.5"
},
{
"identity" : "rim",
"map" : "./part[partType = PFX]"
},
{
"identity" : "servd",
"map" : "./TitleCode"
}
]
},
{
"id" : "Patient.name.suffix",
"path" : "Patient.name.suffix",
"short" : "Parts that come after the name",
"definition" : "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "*",
"base" : {
"path" : "HumanName.suffix",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"orderMeaning" : "Suffixes appear in the correct order for presenting the name",
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XPN/4"
},
{
"identity" : "rim",
"map" : "./part[partType = SFX]"
}
]
},
{
"id" : "Patient.name.period",
"path" : "Patient.name.period",
"short" : "Time period when name was/is in use",
"definition" : "Indicates the period of time when this name was valid for the named person.",
"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.",
"requirements" : "Allows names to be placed in historical context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "HumanName.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "per-1",
"severity" : "error",
"human" : "If present, start SHALL have a lower value than end",
"expression" : "start.empty() or end.empty() or (start <= end)",
"xpath" : "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR"
},
{
"identity" : "rim",
"map" : "IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]"
},
{
"identity" : "v2",
"map" : "XPN.13 + XPN.14"
},
{
"identity" : "rim",
"map" : "./usablePeriod[type="IVL<TS>"]"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Patient.name.period.id",
"path" : "Patient.name.period.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.name.period.extension",
"path" : "Patient.name.period.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.name.period.start",
"path" : "Patient.name.period.start",
"short" : "Starting time with inclusive boundary",
"definition" : "The start of the period. The boundary is inclusive.",
"comment" : "If the low element is missing, the meaning is that the low boundary is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.start",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.1"
},
{
"identity" : "rim",
"map" : "./low"
}
]
},
{
"id" : "Patient.name.period.end",
"path" : "Patient.name.period.end",
"short" : "End time with inclusive boundary, if not ongoing",
"definition" : "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
"comment" : "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.end",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"meaningWhenMissing" : "If the end of the period is missing, it means that the period is ongoing",
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.2"
},
{
"identity" : "rim",
"map" : "./high"
}
]
},
{
"id" : "Patient.telecom",
"path" : "Patient.telecom",
"short" : "A contact detail for the individual",
"definition" : "A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.",
"comment" : "A Patient may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently and also to help with identification. The address may not go directly to the individual, but may reach another party that is able to proxy for the patient (i.e. home phone, or pet owner's phone).",
"requirements" : "People have (primary) ways to contact them in some way such as phone, email.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "ContactPoint"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "cpt-2",
"severity" : "error",
"human" : "A system is required if a value is provided.",
"expression" : "value.empty() or system.exists()",
"xpath" : "not(exists(f:value)) or exists(f:system)"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XTN"
},
{
"identity" : "rim",
"map" : "TEL"
},
{
"identity" : "servd",
"map" : "ContactPoint"
},
{
"identity" : "v2",
"map" : "PID-13, PID-14, PID-40"
},
{
"identity" : "rim",
"map" : "telecom"
},
{
"identity" : "cda",
"map" : ".telecom"
}
]
},
{
"id" : "Patient.telecom.id",
"path" : "Patient.telecom.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.telecom.extension",
"path" : "Patient.telecom.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.telecom.system",
"path" : "Patient.telecom.system",
"short" : "phone | fax | email | pager | url | sms | other",
"definition" : "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1",
"cpt-2"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactPointSystem"
}
],
"strength" : "required",
"description" : "Telecommunications form for contact point",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/contact-point-system"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XTN.3"
},
{
"identity" : "rim",
"map" : "./scheme"
},
{
"identity" : "servd",
"map" : "./ContactPointType"
}
]
},
{
"id" : "Patient.telecom.value",
"path" : "Patient.telecom.value",
"short" : "The actual contact point details",
"definition" : "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"comment" : "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"requirements" : "Need to support legacy numbers that are not in a tightly controlled format.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XTN.1 (or XTN.12)"
},
{
"identity" : "rim",
"map" : "./url"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Patient.telecom.use",
"path" : "Patient.telecom.use",
"short" : "home | work | temp | old | mobile - purpose of this contact point",
"definition" : "Identifies the purpose for the contact point.",
"comment" : "This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"requirements" : "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactPointUse"
}
],
"strength" : "required",
"description" : "Use of contact point",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/contact-point-use"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XTN.2 - but often indicated by field"
},
{
"identity" : "rim",
"map" : "unique(./use)"
},
{
"identity" : "servd",
"map" : "./ContactPointPurpose"
}
]
},
{
"id" : "Patient.telecom.rank",
"path" : "Patient.telecom.rank",
"short" : "Specify preferred order of use (1 = highest)",
"definition" : "Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.",
"comment" : "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.rank",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "positiveInt"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "n/a"
}
]
},
{
"id" : "Patient.telecom.period",
"path" : "Patient.telecom.period",
"short" : "Time period when the contact point was/is in use",
"definition" : "Time period when the contact point was/is in use.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "per-1",
"severity" : "error",
"human" : "If present, start SHALL have a lower value than end",
"expression" : "start.empty() or end.empty() or (start <= end)",
"xpath" : "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR"
},
{
"identity" : "rim",
"map" : "IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "./usablePeriod[type="IVL<TS>"]"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Patient.telecom.period.id",
"path" : "Patient.telecom.period.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.telecom.period.extension",
"path" : "Patient.telecom.period.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.telecom.period.start",
"path" : "Patient.telecom.period.start",
"short" : "Starting time with inclusive boundary",
"definition" : "The start of the period. The boundary is inclusive.",
"comment" : "If the low element is missing, the meaning is that the low boundary is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.start",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.1"
},
{
"identity" : "rim",
"map" : "./low"
}
]
},
{
"id" : "Patient.telecom.period.end",
"path" : "Patient.telecom.period.end",
"short" : "End time with inclusive boundary, if not ongoing",
"definition" : "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
"comment" : "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.end",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"meaningWhenMissing" : "If the end of the period is missing, it means that the period is ongoing",
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.2"
},
{
"identity" : "rim",
"map" : "./high"
}
]
},
{
"id" : "Patient.gender",
"path" : "Patient.gender",
"short" : "male | female | other | unknown",
"definition" : "Administrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.",
"comment" : "The gender may not match the biological sex as determined by genetics, or the individual's preferred identification. Note that for both humans and particularly animals, there are other legitimate possibilities than M and F, though the vast majority of systems and contexts only support M and F. Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific gender aspect of interest (anatomical, chromosonal, social, etc.) However, because these observations are infrequently recorded, defaulting to the administrative gender is common practice. Where such defaulting occurs, rule enforcement should allow for the variation between administrative and biological, chromosonal and other gender aspects. For example, an alert about a hysterectomy on a male should be handled as a warning or overrideable error, not a "hard" error.",
"requirements" : "Needed for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.gender",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "PID-8"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
},
{
"identity" : "cda",
"map" : ".patient.administrativeGenderCode"
}
]
},
{
"id" : "Patient.birthDate",
"path" : "Patient.birthDate",
"short" : "The date of birth for the individual",
"definition" : "The date of birth for the individual.",
"comment" : "At least an estimated year should be provided as a guess if the real DOB is unknown There is a standard extension "patient-birthTime" available that should be used where Time is required (such as in maternaty/infant care systems).",
"requirements" : "Age of the individual drives many clinical processes.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.birthDate",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "date"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "PID-7"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"
},
{
"identity" : "cda",
"map" : ".patient.birthTime"
},
{
"identity" : "loinc",
"map" : "21112-8"
}
]
},
{
"id" : "Patient.deceased[x]",
"path" : "Patient.deceased[x]",
"short" : "Indicates if the individual is deceased or not",
"definition" : "Indicates if the individual is deceased or not.",
"comment" : "If there's no value in the instance it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.
This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.",
"requirements" : "The fact that a patient is deceased influences the clinical process. Also, in human communication and relation management it is necessary to know whether the person is alive.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.deceased[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
},
{
"code" : "dateTime"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "PID-30 (bool) and PID-29 (datetime)"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.address",
"path" : "Patient.address",
"short" : "Addresses for the individual",
"definition" : "Addresses for the individual.",
"comment" : "Patient may have multiple addresses with different uses or applicable periods.",
"requirements" : "May need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.address",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Address"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD"
},
{
"identity" : "rim",
"map" : "AD"
},
{
"identity" : "servd",
"map" : "Address"
},
{
"identity" : "v2",
"map" : "PID-11"
},
{
"identity" : "rim",
"map" : "addr"
},
{
"identity" : "cda",
"map" : ".addr"
}
]
},
{
"id" : "Patient.address.id",
"path" : "Patient.address.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.address.extension",
"path" : "Patient.address.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.address.use",
"path" : "Patient.address.use",
"short" : "home | work | temp | old - purpose of this address",
"definition" : "The purpose of this address.",
"comment" : "This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.",
"requirements" : "Allows an appropriate address to be chosen from a list of many.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"example" : [
{
"label" : "General",
"valueCode" : "home"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AddressUse"
}
],
"strength" : "required",
"description" : "The use of an address",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/address-use"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.7"
},
{
"identity" : "rim",
"map" : "unique(./use)"
},
{
"identity" : "servd",
"map" : "./AddressPurpose"
}
]
},
{
"id" : "Patient.address.type",
"path" : "Patient.address.type",
"short" : "postal | physical | both",
"definition" : "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"example" : [
{
"label" : "General",
"valueCode" : "both"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AddressType"
}
],
"strength" : "required",
"description" : "The type of an address (physical / postal)",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/address-type"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.18"
},
{
"identity" : "rim",
"map" : "unique(./use)"
},
{
"identity" : "vcard",
"map" : "address type parameter"
}
]
},
{
"id" : "Patient.address.text",
"path" : "Patient.address.text",
"short" : "Text representation of the address",
"definition" : "A full text representation of the address.",
"comment" : "Can provide both a text representation and parts.",
"requirements" : "A renderable, unencoded form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "137 Nowhere Street, Erewhon 9132"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6"
},
{
"identity" : "rim",
"map" : "./formatted"
},
{
"identity" : "vcard",
"map" : "address label parameter"
}
]
},
{
"id" : "Patient.address.line",
"path" : "Patient.address.line",
"short" : "Street name, number, direction & P.O. Box etc.",
"definition" : "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "home | work | temp | old - purpose of this address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Address.line",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"orderMeaning" : "The order in which lines should appear in an address label",
"example" : [
{
"label" : "General",
"valueString" : "137 Nowhere Street"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = AL]"
},
{
"identity" : "vcard",
"map" : "street"
},
{
"identity" : "servd",
"map" : "./StreetAddress (newline delimitted)"
}
]
},
{
"id" : "Patient.address.city",
"path" : "Patient.address.city",
"short" : "Name of city, town etc.",
"definition" : "The name of the city, town, village or other community or delivery center.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"alias" : [
"Municpality"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.city",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "Erewhon"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.3"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = CTY]"
},
{
"identity" : "vcard",
"map" : "locality"
},
{
"identity" : "servd",
"map" : "./Jurisdiction"
}
]
},
{
"id" : "Patient.address.district",
"path" : "Patient.address.district",
"short" : "District name (aka county)",
"definition" : "The name of the administrative area (county).",
"comment" : "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.",
"alias" : [
"County"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.district",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "Madison"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.9"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = CNT | CPA]"
}
]
},
{
"id" : "Patient.address.state",
"path" : "Patient.address.state",
"short" : "Sub-unit of country (abbreviations ok)",
"definition" : "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"alias" : [
"Province",
"Territory"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.state",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.4"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = STA]"
},
{
"identity" : "vcard",
"map" : "region"
},
{
"identity" : "servd",
"map" : "./Region"
}
]
},
{
"id" : "Patient.address.postalCode",
"path" : "Patient.address.postalCode",
"short" : "Postal code for area",
"definition" : "A postal code designating a region defined by the postal service.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"alias" : [
"Zip"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.postalCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "9132"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.5"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = ZIP]"
},
{
"identity" : "vcard",
"map" : "code"
},
{
"identity" : "servd",
"map" : "./PostalIdentificationCode"
}
]
},
{
"id" : "Patient.address.country",
"path" : "Patient.address.country",
"short" : "Country (e.g. can be ISO 3166 2 or 3 letter code)",
"definition" : "Country - a nation as commonly understood or generally accepted.",
"comment" : "ISO 3166 3 letter codes can be used in place of a full country name.
Required for cross-border exchange of IPS",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.country",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.6"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = CNT]"
},
{
"identity" : "vcard",
"map" : "country"
},
{
"identity" : "servd",
"map" : "./Country"
}
]
},
{
"id" : "Patient.address.period",
"path" : "Patient.address.period",
"short" : "Time period when address was/is in use",
"definition" : "Time period when address was/is in use.",
"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.",
"requirements" : "Allows addresses to be placed in historical context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"example" : [
{
"label" : "General",
"valuePeriod" : {
"start" : "2010-03-23T00:00:00+11:00",
"end" : "2010-07-01T00:00:00+10:00"
}
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "per-1",
"severity" : "error",
"human" : "If present, start SHALL have a lower value than end",
"expression" : "start.empty() or end.empty() or (start <= end)",
"xpath" : "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR"
},
{
"identity" : "rim",
"map" : "IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]"
},
{
"identity" : "v2",
"map" : "XAD.12 / XAD.13 + XAD.14"
},
{
"identity" : "rim",
"map" : "./usablePeriod[type="IVL<TS>"]"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Patient.address.period.id",
"path" : "Patient.address.period.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.address.period.extension",
"path" : "Patient.address.period.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.address.period.start",
"path" : "Patient.address.period.start",
"short" : "Starting time with inclusive boundary",
"definition" : "The start of the period. The boundary is inclusive.",
"comment" : "If the low element is missing, the meaning is that the low boundary is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.start",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.1"
},
{
"identity" : "rim",
"map" : "./low"
}
]
},
{
"id" : "Patient.address.period.end",
"path" : "Patient.address.period.end",
"short" : "End time with inclusive boundary, if not ongoing",
"definition" : "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
"comment" : "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.end",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"meaningWhenMissing" : "If the end of the period is missing, it means that the period is ongoing",
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.2"
},
{
"identity" : "rim",
"map" : "./high"
}
]
},
{
"id" : "Patient.maritalStatus",
"path" : "Patient.maritalStatus",
"short" : "Marital (civil) status of a patient",
"definition" : "This field contains a patient's most recent marital (civil) status.",
"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.",
"requirements" : "Most, if not all systems capture it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.maritalStatus",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MaritalStatus"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "extensible",
"description" : "The domestic partnership status of a person.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/marital-status"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "PID-16"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN]/maritalStatusCode"
},
{
"identity" : "cda",
"map" : ".patient.maritalStatusCode"
}
]
},
{
"id" : "Patient.maritalStatus.id",
"path" : "Patient.maritalStatus.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.maritalStatus.extension",
"path" : "Patient.maritalStatus.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.maritalStatus.coding",
"path" : "Patient.maritalStatus.coding",
"short" : "Code defined by a terminology system",
"definition" : "A reference to a code defined by a terminology system.",
"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.",
"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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity" : "rim",
"map" : "CV"
},
{
"identity" : "orim",
"map" : "fhir:Coding rdfs:subClassOf dt:CDCoding"
},
{
"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" : "Patient.maritalStatus.coding.id",
"path" : "Patient.maritalStatus.coding.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.maritalStatus.coding.extension",
"path" : "Patient.maritalStatus.coding.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.maritalStatus.coding.system",
"path" : "Patient.maritalStatus.coding.system",
"short" : "Identity of the terminology system",
"definition" : "The identification of the code system that defines the meaning of the symbol in the code.",
"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.",
"requirements" : "Need to be unambiguous about the source of the definition of the symbol.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.3"
},
{
"identity" : "rim",
"map" : "./codeSystem"
},
{
"identity" : "orim",
"map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id" : "Patient.maritalStatus.coding.version",
"path" : "Patient.maritalStatus.coding.version",
"short" : "Version of the system - if relevant",
"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.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.version",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.7"
},
{
"identity" : "rim",
"map" : "./codeSystemVersion"
},
{
"identity" : "orim",
"map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id" : "Patient.maritalStatus.coding.code",
"path" : "Patient.maritalStatus.coding.code",
"short" : "Symbol in syntax defined by the system",
"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).",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Need to refer to a particular code in the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.1"
},
{
"identity" : "rim",
"map" : "./code"
},
{
"identity" : "orim",
"map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id" : "Patient.maritalStatus.coding.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.maritalStatus.coding.display",
"short" : "Representation defined by the system",
"definition" : "A representation of the meaning of the code in the system, following the rules of the system.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.2 - but note this is not well followed"
},
{
"identity" : "rim",
"map" : "CV.displayName"
},
{
"identity" : "orim",
"map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
}
]
},
{
"id" : "Patient.maritalStatus.coding.userSelected",
"path" : "Patient.maritalStatus.coding.userSelected",
"short" : "If this coding was chosen directly by the user",
"definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"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.",
"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,
"max" : "1",
"base" : {
"path" : "Coding.userSelected",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "Sometimes implied by being first"
},
{
"identity" : "rim",
"map" : "CD.codingRationale"
},
{
"identity" : "orim",
"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 ]"
}
]
},
{
"id" : "Patient.maritalStatus.text",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.maritalStatus.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.",
"comment" : "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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"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" : "Patient.multipleBirth[x]",
"path" : "Patient.multipleBirth[x]",
"short" : "Whether patient is part of a multiple birth",
"definition" : "Indicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).",
"comment" : "Where the valueInteger is provided, the number is the birth number in the sequence.
E.g. The middle birth in tripplets would be valueInteger=2 and the third born would have valueInteger=3
If a bool value was provided for this tripplets examle, then all 3 patient records would have valueBool=true (the ordering is not indicated).",
"requirements" : "For disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.multipleBirth[x]",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
},
{
"code" : "integer"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "PID-24 (bool), PID-25 (integer)"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.photo",
"path" : "Patient.photo",
"short" : "Image of the patient",
"definition" : "Image of the patient.",
"comment" : "When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Attachment".",
"requirements" : "Many EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.photo",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Attachment"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "att-1",
"severity" : "error",
"human" : "It the Attachment has data, it SHALL have a contentType",
"expression" : "data.empty() or contentType.exists()",
"xpath" : "not(exists(f:data)) or exists(f:contentType)"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "ED/RP"
},
{
"identity" : "rim",
"map" : "ED"
},
{
"identity" : "v2",
"map" : "OBX-5 - needs a profile"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.photo.id",
"path" : "Patient.photo.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.photo.extension",
"path" : "Patient.photo.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.photo.contentType",
"path" : "Patient.photo.contentType",
"short" : "Mime type of the content, with charset etc.",
"definition" : "Identifies the type of the data in the attachment and allows a method to be chosen to interpret or render the data. Includes mime type parameters such as charset where appropriate.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Processors of the data need to be able to know how to interpret the data.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Attachment.contentType",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"example" : [
{
"label" : "General",
"valueCode" : "text/plain; charset=UTF-8, image/png"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "MimeType"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "required",
"description" : "The mime type of an attachment. Any valid mime type is allowed.",
"valueSetUri" : "http://www.rfc-editor.org/bcp/bcp13.txt"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "ED.2+ED.3/RP.2+RP.3. Note conversion may be needed if old style values are being used"
},
{
"identity" : "rim",
"map" : "./mediaType, ./charset"
}
]
},
{
"id" : "Patient.photo.language",
"path" : "Patient.photo.language",
"short" : "Human language of the content (BCP-47)",
"definition" : "The human language of the content. The value can be any valid value according to BCP 47.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Users need to be able to choose between the languages in a set of attachments.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Attachment.language",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"example" : [
{
"label" : "General",
"valueCode" : "en-AU"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"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
}
],
"strength" : "extensible",
"description" : "A human language.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/languages"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "./language"
}
]
},
{
"id" : "Patient.photo.data",
"path" : "Patient.photo.data",
"short" : "Data inline, base64ed",
"definition" : "The actual data of the attachment - a sequence of bytes. In XML, represented using base64.",
"comment" : "The base64-encoded data SHALL be expressed in the same character set as the base resource XML or JSON.",
"requirements" : "The data needs to able to be transmitted inline.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Attachment.data",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "base64Binary"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "ED.5"
},
{
"identity" : "rim",
"map" : "./data"
}
]
},
{
"id" : "Patient.photo.url",
"path" : "Patient.photo.url",
"short" : "Uri where the data can be found",
"definition" : "An alternative location where the data can be accessed.",
"comment" : "If both data and url are provided, the url SHALL point to the same content as the data contains. Urls may be relative references or may reference transient locations such as a wrapping envelope using cid: though this has ramifications for using signatures. Relative URLs are interpreted relative to the service url, like a resource reference, rather than relative to the resource itself. If a URL is provided, it SHALL resolve to actual data.",
"requirements" : "The data needs to be transmitted by reference.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Attachment.url",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"example" : [
{
"label" : "General",
"valueUri" : "http://www.acme.com/logo-small.png"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "RP.1+RP.2 - if they refer to a URL (see v2.6)"
},
{
"identity" : "rim",
"map" : "./reference/literal"
}
]
},
{
"id" : "Patient.photo.size",
"path" : "Patient.photo.size",
"short" : "Number of bytes of content (if url provided)",
"definition" : "The number of bytes of data that make up this attachment (before base64 encoding, if that is done).",
"comment" : "The number of bytes is redundant if the data is provided as a base64binary, but is useful if the data is provided as a url reference.",
"requirements" : "Representing the size allows applications to determine whether they should fetch the content automatically in advance, or refuse to fetch it at all.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Attachment.size",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "unsignedInt"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A (needs data type R3 proposal)"
}
]
},
{
"id" : "Patient.photo.hash",
"path" : "Patient.photo.hash",
"short" : "Hash of the data (sha-1, base64ed)",
"definition" : "The calculated hash of the data using SHA-1. Represented using base64.",
"comment" : "The hash is calculated on the data prior to base64 encoding, if the data is based64 encoded.",
"requirements" : "Included so that applications can verify that the contents of a location have not changed and so that a signature of the content can implicitly sign the content of an image without having to include the data in the instance or reference the url in the signature.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Attachment.hash",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "base64Binary"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : ".integrityCheck[parent::ED/integrityCheckAlgorithm="SHA-1"]"
}
]
},
{
"id" : "Patient.photo.title",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.photo.title",
"short" : "Label to display in place of the data",
"definition" : "A label or set of text to display in place of the data.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Applications need a label to display to a human user in place of the actual data if the data cannot be rendered or perceived by the viewer.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Attachment.title",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "Official Corporate Logo"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "./title/data"
}
]
},
{
"id" : "Patient.photo.creation",
"path" : "Patient.photo.creation",
"short" : "Date attachment was first created",
"definition" : "The date that the attachment was first created.",
"requirements" : "This is often tracked as an integrity issue for use of the attachment.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Attachment.creation",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A (needs data type R3 proposal)"
}
]
},
{
"id" : "Patient.contact",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Contact"
}
],
"path" : "Patient.contact",
"short" : "A contact party (e.g. guardian, partner, friend) for the patient",
"definition" : "A contact party (e.g. guardian, partner, friend) for the patient.",
"comment" : "Contact covers all kinds of contact parties: family members, business contacts, guardians, caregivers. Not applicable to register pedigree and family ties beyond use of having contact.",
"requirements" : "Need to track people you can contact about the patient.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.contact",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "pat-1",
"severity" : "error",
"human" : "SHALL at least contain a contact's details or a reference to an organization",
"expression" : "name.exists() or telecom.exists() or address.exists() or organization.exists()",
"xpath" : "exists(f:name) or exists(f:telecom) or exists(f:address) or exists(f:organization)"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.id",
"path" : "Patient.contact.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.extension",
"path" : "Patient.contact.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.contact.modifierExtension",
"path" : "Patient.contact.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.",
"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.",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.contact.relationship",
"path" : "Patient.contact.relationship",
"short" : "The kind of relationship",
"definition" : "The nature of the relationship between the patient and the contact person.",
"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.",
"requirements" : "Used to determine which contact person is the most relevant to approach, depending on circumstances.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.contact.relationship",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "CodeableConcept",
"profile" : "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactRelationship"
}
],
"strength" : "required",
"description" : "The nature of the relationship between a patient and a contact person for that patient.",
"valueSetUri" : "http://hl7.org/fhir/uv/ips/ValueSet/personal-relationship-uv-ips"
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "NK1-7, NK1-3"
},
{
"identity" : "rim",
"map" : "code"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.relationship.id",
"path" : "Patient.contact.relationship.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.relationship.extension",
"path" : "Patient.contact.relationship.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.contact.relationship.coding",
"path" : "Patient.contact.relationship.coding",
"short" : "Code defined by a terminology system",
"definition" : "A reference to a code defined by a terminology system.",
"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.",
"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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity" : "rim",
"map" : "CV"
},
{
"identity" : "orim",
"map" : "fhir:Coding rdfs:subClassOf dt:CDCoding"
},
{
"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" : "Patient.contact.relationship.coding.id",
"path" : "Patient.contact.relationship.coding.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.relationship.coding.extension",
"path" : "Patient.contact.relationship.coding.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.contact.relationship.coding.system",
"path" : "Patient.contact.relationship.coding.system",
"short" : "Identity of the terminology system",
"definition" : "The identification of the code system that defines the meaning of the symbol in the code.",
"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.",
"requirements" : "Need to be unambiguous about the source of the definition of the symbol.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.3"
},
{
"identity" : "rim",
"map" : "./codeSystem"
},
{
"identity" : "orim",
"map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id" : "Patient.contact.relationship.coding.version",
"path" : "Patient.contact.relationship.coding.version",
"short" : "Version of the system - if relevant",
"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.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.version",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.7"
},
{
"identity" : "rim",
"map" : "./codeSystemVersion"
},
{
"identity" : "orim",
"map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id" : "Patient.contact.relationship.coding.code",
"path" : "Patient.contact.relationship.coding.code",
"short" : "Symbol in syntax defined by the system",
"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).",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Need to refer to a particular code in the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.1"
},
{
"identity" : "rim",
"map" : "./code"
},
{
"identity" : "orim",
"map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id" : "Patient.contact.relationship.coding.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.contact.relationship.coding.display",
"short" : "Representation defined by the system",
"definition" : "A representation of the meaning of the code in the system, following the rules of the system.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.2 - but note this is not well followed"
},
{
"identity" : "rim",
"map" : "CV.displayName"
},
{
"identity" : "orim",
"map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
}
]
},
{
"id" : "Patient.contact.relationship.coding.userSelected",
"path" : "Patient.contact.relationship.coding.userSelected",
"short" : "If this coding was chosen directly by the user",
"definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"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.",
"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,
"max" : "1",
"base" : {
"path" : "Coding.userSelected",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "Sometimes implied by being first"
},
{
"identity" : "rim",
"map" : "CD.codingRationale"
},
{
"identity" : "orim",
"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 ]"
}
]
},
{
"id" : "Patient.contact.relationship.text",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.contact.relationship.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.",
"comment" : "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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"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" : "Patient.contact.name",
"path" : "Patient.contact.name",
"short" : "A name associated with the contact person",
"definition" : "A name associated with the contact person.",
"comment" : "Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.",
"requirements" : "Contact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.contact.name",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "HumanName"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XPN"
},
{
"identity" : "rim",
"map" : "EN (actually, PN)"
},
{
"identity" : "servd",
"map" : "ProviderName"
},
{
"identity" : "v2",
"map" : "NK1-2"
},
{
"identity" : "rim",
"map" : "name"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.name.id",
"path" : "Patient.contact.name.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.name.extension",
"path" : "Patient.contact.name.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.contact.name.use",
"path" : "Patient.contact.name.use",
"short" : "usual | official | temp | nickname | anonymous | old | maiden",
"definition" : "Identifies the purpose for this name.",
"comment" : "This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.",
"requirements" : "Allows the appropriate name for a particular context of use to be selected from among a set of names.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "HumanName.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "NameUse"
}
],
"strength" : "required",
"description" : "The use of a human name",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/name-use"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XPN.7, but often indicated by which field contains the name"
},
{
"identity" : "rim",
"map" : "unique(./use)"
},
{
"identity" : "servd",
"map" : "./NamePurpose"
}
]
},
{
"id" : "Patient.contact.name.text",
"path" : "Patient.contact.name.text",
"short" : "Text representation of the full name",
"definition" : "A full text representation of the name.",
"comment" : "Can provide both a text representation and structured parts.",
"requirements" : "A renderable, unencoded form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "HumanName.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "implied by XPN.11"
},
{
"identity" : "rim",
"map" : "./formatted"
}
]
},
{
"id" : "Patient.contact.name.family",
"path" : "Patient.contact.name.family",
"short" : "Family name (often called 'Surname')",
"definition" : "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.",
"comment" : "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).",
"alias" : [
"surname"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "HumanName.family",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XPN.1/FN.1"
},
{
"identity" : "rim",
"map" : "./part[partType = FAM]"
},
{
"identity" : "servd",
"map" : "./FamilyName"
}
]
},
{
"id" : "Patient.contact.name.given",
"path" : "Patient.contact.name.given",
"short" : "Given names (not always 'first'). Includes middle names",
"definition" : "Given name.",
"comment" : "If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first.",
"alias" : [
"first name",
"middle name"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "HumanName.given",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"orderMeaning" : "Given Names appear in the correct order for presenting the name",
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XPN.2 + XPN.3"
},
{
"identity" : "rim",
"map" : "./part[partType = GIV]"
},
{
"identity" : "servd",
"map" : "./GivenNames"
}
]
},
{
"id" : "Patient.contact.name.prefix",
"path" : "Patient.contact.name.prefix",
"short" : "Parts that come before the name",
"definition" : "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "*",
"base" : {
"path" : "HumanName.prefix",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"orderMeaning" : "Prefixes appear in the correct order for presenting the name",
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XPN.5"
},
{
"identity" : "rim",
"map" : "./part[partType = PFX]"
},
{
"identity" : "servd",
"map" : "./TitleCode"
}
]
},
{
"id" : "Patient.contact.name.suffix",
"path" : "Patient.contact.name.suffix",
"short" : "Parts that come after the name",
"definition" : "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "*",
"base" : {
"path" : "HumanName.suffix",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"orderMeaning" : "Suffixes appear in the correct order for presenting the name",
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XPN/4"
},
{
"identity" : "rim",
"map" : "./part[partType = SFX]"
}
]
},
{
"id" : "Patient.contact.name.period",
"path" : "Patient.contact.name.period",
"short" : "Time period when name was/is in use",
"definition" : "Indicates the period of time when this name was valid for the named person.",
"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.",
"requirements" : "Allows names to be placed in historical context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "HumanName.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "per-1",
"severity" : "error",
"human" : "If present, start SHALL have a lower value than end",
"expression" : "start.empty() or end.empty() or (start <= end)",
"xpath" : "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR"
},
{
"identity" : "rim",
"map" : "IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]"
},
{
"identity" : "v2",
"map" : "XPN.13 + XPN.14"
},
{
"identity" : "rim",
"map" : "./usablePeriod[type="IVL<TS>"]"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Patient.contact.name.period.id",
"path" : "Patient.contact.name.period.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.name.period.extension",
"path" : "Patient.contact.name.period.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.contact.name.period.start",
"path" : "Patient.contact.name.period.start",
"short" : "Starting time with inclusive boundary",
"definition" : "The start of the period. The boundary is inclusive.",
"comment" : "If the low element is missing, the meaning is that the low boundary is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.start",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.1"
},
{
"identity" : "rim",
"map" : "./low"
}
]
},
{
"id" : "Patient.contact.name.period.end",
"path" : "Patient.contact.name.period.end",
"short" : "End time with inclusive boundary, if not ongoing",
"definition" : "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
"comment" : "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.end",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"meaningWhenMissing" : "If the end of the period is missing, it means that the period is ongoing",
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.2"
},
{
"identity" : "rim",
"map" : "./high"
}
]
},
{
"id" : "Patient.contact.telecom",
"path" : "Patient.contact.telecom",
"short" : "A contact detail for the person",
"definition" : "A contact detail for the person, e.g. a telephone number or an email address.",
"comment" : "Contact may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.",
"requirements" : "People have (primary) ways to contact them in some way such as phone, email.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.contact.telecom",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "ContactPoint"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "cpt-2",
"severity" : "error",
"human" : "A system is required if a value is provided.",
"expression" : "value.empty() or system.exists()",
"xpath" : "not(exists(f:value)) or exists(f:system)"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XTN"
},
{
"identity" : "rim",
"map" : "TEL"
},
{
"identity" : "servd",
"map" : "ContactPoint"
},
{
"identity" : "v2",
"map" : "NK1-5, NK1-6, NK1-40"
},
{
"identity" : "rim",
"map" : "telecom"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.telecom.id",
"path" : "Patient.contact.telecom.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.telecom.extension",
"path" : "Patient.contact.telecom.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.contact.telecom.system",
"path" : "Patient.contact.telecom.system",
"short" : "phone | fax | email | pager | url | sms | other",
"definition" : "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1",
"cpt-2"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactPointSystem"
}
],
"strength" : "required",
"description" : "Telecommunications form for contact point",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/contact-point-system"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XTN.3"
},
{
"identity" : "rim",
"map" : "./scheme"
},
{
"identity" : "servd",
"map" : "./ContactPointType"
}
]
},
{
"id" : "Patient.contact.telecom.value",
"path" : "Patient.contact.telecom.value",
"short" : "The actual contact point details",
"definition" : "The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).",
"comment" : "Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.",
"requirements" : "Need to support legacy numbers that are not in a tightly controlled format.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.value",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XTN.1 (or XTN.12)"
},
{
"identity" : "rim",
"map" : "./url"
},
{
"identity" : "servd",
"map" : "./Value"
}
]
},
{
"id" : "Patient.contact.telecom.use",
"path" : "Patient.contact.telecom.use",
"short" : "home | work | temp | old | mobile - purpose of this contact point",
"definition" : "Identifies the purpose for the contact point.",
"comment" : "This is labeled as "Is Modifier" because applications should not mistake a temporary or old contact etc.for a current/permanent one. Applications can assume that a contact is current unless it explicitly says that it is temporary or old.",
"requirements" : "Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactPointUse"
}
],
"strength" : "required",
"description" : "Use of contact point",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/contact-point-use"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XTN.2 - but often indicated by field"
},
{
"identity" : "rim",
"map" : "unique(./use)"
},
{
"identity" : "servd",
"map" : "./ContactPointPurpose"
}
]
},
{
"id" : "Patient.contact.telecom.rank",
"path" : "Patient.contact.telecom.rank",
"short" : "Specify preferred order of use (1 = highest)",
"definition" : "Specifies a preferred order in which to use a set of contacts. Contacts are ranked with lower values coming before higher values.",
"comment" : "Note that rank does not necessarily follow the order in which the contacts are represented in the instance.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.rank",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "positiveInt"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.telecom.period",
"path" : "Patient.contact.telecom.period",
"short" : "Time period when the contact point was/is in use",
"definition" : "Time period when the contact point was/is in use.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ContactPoint.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "per-1",
"severity" : "error",
"human" : "If present, start SHALL have a lower value than end",
"expression" : "start.empty() or end.empty() or (start <= end)",
"xpath" : "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR"
},
{
"identity" : "rim",
"map" : "IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "./usablePeriod[type="IVL<TS>"]"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Patient.contact.telecom.period.id",
"path" : "Patient.contact.telecom.period.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.telecom.period.extension",
"path" : "Patient.contact.telecom.period.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.contact.telecom.period.start",
"path" : "Patient.contact.telecom.period.start",
"short" : "Starting time with inclusive boundary",
"definition" : "The start of the period. The boundary is inclusive.",
"comment" : "If the low element is missing, the meaning is that the low boundary is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.start",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.1"
},
{
"identity" : "rim",
"map" : "./low"
}
]
},
{
"id" : "Patient.contact.telecom.period.end",
"path" : "Patient.contact.telecom.period.end",
"short" : "End time with inclusive boundary, if not ongoing",
"definition" : "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
"comment" : "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.end",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"meaningWhenMissing" : "If the end of the period is missing, it means that the period is ongoing",
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.2"
},
{
"identity" : "rim",
"map" : "./high"
}
]
},
{
"id" : "Patient.contact.address",
"path" : "Patient.contact.address",
"short" : "Address for the contact person",
"definition" : "Address for the contact person.",
"comment" : "Note: address is for postal addresses, not physical locations.",
"requirements" : "Need to keep track where the contact person can be contacted per postal mail or visited.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.contact.address",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Address"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD"
},
{
"identity" : "rim",
"map" : "AD"
},
{
"identity" : "servd",
"map" : "Address"
},
{
"identity" : "v2",
"map" : "NK1-4"
},
{
"identity" : "rim",
"map" : "addr"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.address.id",
"path" : "Patient.contact.address.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.address.extension",
"path" : "Patient.contact.address.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.contact.address.use",
"path" : "Patient.contact.address.use",
"short" : "home | work | temp | old - purpose of this address",
"definition" : "The purpose of this address.",
"comment" : "This is labeled as "Is Modifier" because applications should not mistake a temporary or old address etc.for a current/permanent one. Applications can assume that an address is current unless it explicitly says that it is temporary or old.",
"requirements" : "Allows an appropriate address to be chosen from a list of many.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.use",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"example" : [
{
"label" : "General",
"valueCode" : "home"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AddressUse"
}
],
"strength" : "required",
"description" : "The use of an address",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/address-use"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.7"
},
{
"identity" : "rim",
"map" : "unique(./use)"
},
{
"identity" : "servd",
"map" : "./AddressPurpose"
}
]
},
{
"id" : "Patient.contact.address.type",
"path" : "Patient.contact.address.type",
"short" : "postal | physical | both",
"definition" : "Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.type",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"example" : [
{
"label" : "General",
"valueCode" : "both"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AddressType"
}
],
"strength" : "required",
"description" : "The type of an address (physical / postal)",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/address-type"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.18"
},
{
"identity" : "rim",
"map" : "unique(./use)"
},
{
"identity" : "vcard",
"map" : "address type parameter"
}
]
},
{
"id" : "Patient.contact.address.text",
"path" : "Patient.contact.address.text",
"short" : "Text representation of the address",
"definition" : "A full text representation of the address.",
"comment" : "Can provide both a text representation and parts.",
"requirements" : "A renderable, unencoded form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.text",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "137 Nowhere Street, Erewhon 9132"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6"
},
{
"identity" : "rim",
"map" : "./formatted"
},
{
"identity" : "vcard",
"map" : "address label parameter"
}
]
},
{
"id" : "Patient.contact.address.line",
"path" : "Patient.contact.address.line",
"short" : "Street name, number, direction & P.O. Box etc.",
"definition" : "This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "home | work | temp | old - purpose of this address.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Address.line",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "string"
}
],
"orderMeaning" : "The order in which lines should appear in an address label",
"example" : [
{
"label" : "General",
"valueString" : "137 Nowhere Street"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = AL]"
},
{
"identity" : "vcard",
"map" : "street"
},
{
"identity" : "servd",
"map" : "./StreetAddress (newline delimitted)"
}
]
},
{
"id" : "Patient.contact.address.city",
"path" : "Patient.contact.address.city",
"short" : "Name of city, town etc.",
"definition" : "The name of the city, town, village or other community or delivery center.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"alias" : [
"Municpality"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.city",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "Erewhon"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.3"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = CTY]"
},
{
"identity" : "vcard",
"map" : "locality"
},
{
"identity" : "servd",
"map" : "./Jurisdiction"
}
]
},
{
"id" : "Patient.contact.address.district",
"path" : "Patient.contact.address.district",
"short" : "District name (aka county)",
"definition" : "The name of the administrative area (county).",
"comment" : "District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.",
"alias" : [
"County"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.district",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "Madison"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.9"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = CNT | CPA]"
}
]
},
{
"id" : "Patient.contact.address.state",
"path" : "Patient.contact.address.state",
"short" : "Sub-unit of country (abbreviations ok)",
"definition" : "Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (i.e. US 2 letter state codes).",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"alias" : [
"Province",
"Territory"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.state",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.4"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = STA]"
},
{
"identity" : "vcard",
"map" : "region"
},
{
"identity" : "servd",
"map" : "./Region"
}
]
},
{
"id" : "Patient.contact.address.postalCode",
"path" : "Patient.contact.address.postalCode",
"short" : "Postal code for area",
"definition" : "A postal code designating a region defined by the postal service.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"alias" : [
"Zip"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.postalCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"example" : [
{
"label" : "General",
"valueString" : "9132"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.5"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = ZIP]"
},
{
"identity" : "vcard",
"map" : "code"
},
{
"identity" : "servd",
"map" : "./PostalIdentificationCode"
}
]
},
{
"id" : "Patient.contact.address.country",
"path" : "Patient.contact.address.country",
"short" : "Country (e.g. can be ISO 3166 2 or 3 letter code)",
"definition" : "Country - a nation as commonly understood or generally accepted.",
"comment" : "ISO 3166 3 letter codes can be used in place of a full country name.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.country",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "XAD.6"
},
{
"identity" : "rim",
"map" : "AD.part[parttype = CNT]"
},
{
"identity" : "vcard",
"map" : "country"
},
{
"identity" : "servd",
"map" : "./Country"
}
]
},
{
"id" : "Patient.contact.address.period",
"path" : "Patient.contact.address.period",
"short" : "Time period when address was/is in use",
"definition" : "Time period when address was/is in use.",
"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.",
"requirements" : "Allows addresses to be placed in historical context.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Address.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"example" : [
{
"label" : "General",
"valuePeriod" : {
"start" : "2010-03-23T00:00:00+11:00",
"end" : "2010-07-01T00:00:00+10:00"
}
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "per-1",
"severity" : "error",
"human" : "If present, start SHALL have a lower value than end",
"expression" : "start.empty() or end.empty() or (start <= end)",
"xpath" : "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR"
},
{
"identity" : "rim",
"map" : "IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]"
},
{
"identity" : "v2",
"map" : "XAD.12 / XAD.13 + XAD.14"
},
{
"identity" : "rim",
"map" : "./usablePeriod[type="IVL<TS>"]"
},
{
"identity" : "servd",
"map" : "./StartDate and ./EndDate"
}
]
},
{
"id" : "Patient.contact.address.period.id",
"path" : "Patient.contact.address.period.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.address.period.extension",
"path" : "Patient.contact.address.period.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.contact.address.period.start",
"path" : "Patient.contact.address.period.start",
"short" : "Starting time with inclusive boundary",
"definition" : "The start of the period. The boundary is inclusive.",
"comment" : "If the low element is missing, the meaning is that the low boundary is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.start",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.1"
},
{
"identity" : "rim",
"map" : "./low"
}
]
},
{
"id" : "Patient.contact.address.period.end",
"path" : "Patient.contact.address.period.end",
"short" : "End time with inclusive boundary, if not ongoing",
"definition" : "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
"comment" : "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.end",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"meaningWhenMissing" : "If the end of the period is missing, it means that the period is ongoing",
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.2"
},
{
"identity" : "rim",
"map" : "./high"
}
]
},
{
"id" : "Patient.contact.gender",
"path" : "Patient.contact.gender",
"short" : "male | female | other | unknown",
"definition" : "Administrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Needed to address the person correctly.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.contact.gender",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AdministrativeGender"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding",
"valueBoolean" : true
}
],
"strength" : "required",
"description" : "The gender of a person used for administrative purposes.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "NK1-15"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.organization",
"path" : "Patient.contact.organization",
"short" : "Organization that is associated with the contact",
"definition" : "Organization on behalf of which the contact is acting or for which the contact is working.",
"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.",
"requirements" : "For guardians or business related contacts, the organization is relevant.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.contact.organization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"condition" : [
"ele-1",
"pat-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))",
"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, '#')])"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "v2",
"map" : "NK1-13, NK1-30, NK1-31, NK1-32, NK1-41"
},
{
"identity" : "rim",
"map" : "scoper"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.organization.id",
"path" : "Patient.contact.organization.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.organization.extension",
"path" : "Patient.contact.organization.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.contact.organization.reference",
"path" : "Patient.contact.organization.reference",
"short" : "Literal reference, Relative, internal or absolute URL",
"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.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.reference",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1",
"ref-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.contact.organization.identifier",
"path" : "Patient.contact.organization.identifier",
"short" : "Logical reference, when literal reference is not known",
"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.",
"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.
When 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
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Reference.identifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"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" : "servd",
"map" : "Identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
}
]
},
{
"id" : "Patient.contact.organization.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.contact.organization.display",
"short" : "Text alternative for the resource",
"definition" : "Plain text narrative that identifies the resource in addition to the resource reference.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.contact.period",
"path" : "Patient.contact.period",
"short" : "The period during which this contact person or organization is valid to be contacted relating to this patient",
"definition" : "The period during which this contact person or organization is valid to be contacted relating to this patient.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.contact.period",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Period"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "per-1",
"severity" : "error",
"human" : "If present, start SHALL have a lower value than end",
"expression" : "start.empty() or end.empty() or (start <= end)",
"xpath" : "not(exists(f:start)) or not(exists(f:end)) or (f:start/@value <= f:end/@value)"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR"
},
{
"identity" : "rim",
"map" : "IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]"
},
{
"identity" : "rim",
"map" : "effectiveTime"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.period.id",
"path" : "Patient.contact.period.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.contact.period.extension",
"path" : "Patient.contact.period.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.contact.period.start",
"path" : "Patient.contact.period.start",
"short" : "Starting time with inclusive boundary",
"definition" : "The start of the period. The boundary is inclusive.",
"comment" : "If the low element is missing, the meaning is that the low boundary is not known.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.start",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.1"
},
{
"identity" : "rim",
"map" : "./low"
}
]
},
{
"id" : "Patient.contact.period.end",
"path" : "Patient.contact.period.end",
"short" : "End time with inclusive boundary, if not ongoing",
"definition" : "The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.",
"comment" : "The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Period.end",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "dateTime"
}
],
"meaningWhenMissing" : "If the end of the period is missing, it means that the period is ongoing",
"condition" : [
"ele-1",
"per-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "DR.2"
},
{
"identity" : "rim",
"map" : "./high"
}
]
},
{
"id" : "Patient.animal",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Animal"
}
],
"path" : "Patient.animal",
"short" : "This patient is known to be an animal (non-human)",
"definition" : "This patient is known to be an animal.",
"comment" : "The animal element is labeled "Is Modifier" since patients may be non-human. Systems SHALL either handle patient details appropriately (e.g. inform users patient is not human) or reject declared animal records. The absense of the animal element does not imply that the patient is a human. If a system requires such a positive assertion that the patient is human, an extension will be required. (Do not use a species of homo-sapiens in animal species, as this would incorrectly infer that the patient is an animal).",
"requirements" : "Many clinical systems are extended to care for animal patients as well as human.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Patient.animal",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "player[classCode=ANM]"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.animal.id",
"path" : "Patient.animal.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.animal.extension",
"path" : "Patient.animal.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.animal.modifierExtension",
"path" : "Patient.animal.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.",
"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.",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.animal.species",
"path" : "Patient.animal.species",
"short" : "E.g. Dog, Cow",
"definition" : "Identifies the high level taxonomic categorization of the kind of animal.",
"comment" : "If the patient is non-human, at least a species SHALL be specified. Species SHALL be a widely recognised taxonomic classification. It may or may not be Linnaean taxonomy and may or may not be at the level of species. If the level is finer than species--such as a breed code--the code system used SHALL allow inference of the species. (The common example is that the word "Hereford" does not allow inference of the species Bos taurus, because there is a Hereford pig breed, but the SNOMED CT code for "Hereford Cattle Breed" does.).",
"requirements" : "Need to know what kind of animal.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.animal.species",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AnimalSpecies"
}
],
"strength" : "example",
"description" : "The species of an animal.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/animal-species"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "PID-35"
},
{
"identity" : "rim",
"map" : "code"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.animal.species.id",
"path" : "Patient.animal.species.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.animal.species.extension",
"path" : "Patient.animal.species.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.animal.species.coding",
"path" : "Patient.animal.species.coding",
"short" : "Code defined by a terminology system",
"definition" : "A reference to a code defined by a terminology system.",
"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.",
"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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity" : "rim",
"map" : "CV"
},
{
"identity" : "orim",
"map" : "fhir:Coding rdfs:subClassOf dt:CDCoding"
},
{
"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" : "Patient.animal.species.coding.id",
"path" : "Patient.animal.species.coding.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.animal.species.coding.extension",
"path" : "Patient.animal.species.coding.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.animal.species.coding.system",
"path" : "Patient.animal.species.coding.system",
"short" : "Identity of the terminology system",
"definition" : "The identification of the code system that defines the meaning of the symbol in the code.",
"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.",
"requirements" : "Need to be unambiguous about the source of the definition of the symbol.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.3"
},
{
"identity" : "rim",
"map" : "./codeSystem"
},
{
"identity" : "orim",
"map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id" : "Patient.animal.species.coding.version",
"path" : "Patient.animal.species.coding.version",
"short" : "Version of the system - if relevant",
"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.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.version",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.7"
},
{
"identity" : "rim",
"map" : "./codeSystemVersion"
},
{
"identity" : "orim",
"map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id" : "Patient.animal.species.coding.code",
"path" : "Patient.animal.species.coding.code",
"short" : "Symbol in syntax defined by the system",
"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).",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Need to refer to a particular code in the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.1"
},
{
"identity" : "rim",
"map" : "./code"
},
{
"identity" : "orim",
"map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id" : "Patient.animal.species.coding.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.animal.species.coding.display",
"short" : "Representation defined by the system",
"definition" : "A representation of the meaning of the code in the system, following the rules of the system.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.2 - but note this is not well followed"
},
{
"identity" : "rim",
"map" : "CV.displayName"
},
{
"identity" : "orim",
"map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
}
]
},
{
"id" : "Patient.animal.species.coding.userSelected",
"path" : "Patient.animal.species.coding.userSelected",
"short" : "If this coding was chosen directly by the user",
"definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"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.",
"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,
"max" : "1",
"base" : {
"path" : "Coding.userSelected",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "Sometimes implied by being first"
},
{
"identity" : "rim",
"map" : "CD.codingRationale"
},
{
"identity" : "orim",
"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 ]"
}
]
},
{
"id" : "Patient.animal.species.text",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.animal.species.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.",
"comment" : "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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"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" : "Patient.animal.breed",
"path" : "Patient.animal.breed",
"short" : "E.g. Poodle, Angus",
"definition" : "Identifies the detailed categorization of the kind of animal.",
"comment" : "Breed MAY be used to provide further taxonomic or non-taxonomic classification. It may involve local or proprietary designation--such as commercial strain--and/or additional information such as production type.",
"requirements" : "May need to know the specific kind within the species.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.animal.breed",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AnimalBreed"
}
],
"strength" : "example",
"description" : "The breed of an animal.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/animal-breeds"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "PID-37"
},
{
"identity" : "rim",
"map" : "playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.animal.breed.id",
"path" : "Patient.animal.breed.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.animal.breed.extension",
"path" : "Patient.animal.breed.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.animal.breed.coding",
"path" : "Patient.animal.breed.coding",
"short" : "Code defined by a terminology system",
"definition" : "A reference to a code defined by a terminology system.",
"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.",
"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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity" : "rim",
"map" : "CV"
},
{
"identity" : "orim",
"map" : "fhir:Coding rdfs:subClassOf dt:CDCoding"
},
{
"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" : "Patient.animal.breed.coding.id",
"path" : "Patient.animal.breed.coding.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.animal.breed.coding.extension",
"path" : "Patient.animal.breed.coding.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.animal.breed.coding.system",
"path" : "Patient.animal.breed.coding.system",
"short" : "Identity of the terminology system",
"definition" : "The identification of the code system that defines the meaning of the symbol in the code.",
"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.",
"requirements" : "Need to be unambiguous about the source of the definition of the symbol.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.3"
},
{
"identity" : "rim",
"map" : "./codeSystem"
},
{
"identity" : "orim",
"map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id" : "Patient.animal.breed.coding.version",
"path" : "Patient.animal.breed.coding.version",
"short" : "Version of the system - if relevant",
"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.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.version",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.7"
},
{
"identity" : "rim",
"map" : "./codeSystemVersion"
},
{
"identity" : "orim",
"map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id" : "Patient.animal.breed.coding.code",
"path" : "Patient.animal.breed.coding.code",
"short" : "Symbol in syntax defined by the system",
"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).",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Need to refer to a particular code in the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.1"
},
{
"identity" : "rim",
"map" : "./code"
},
{
"identity" : "orim",
"map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id" : "Patient.animal.breed.coding.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.animal.breed.coding.display",
"short" : "Representation defined by the system",
"definition" : "A representation of the meaning of the code in the system, following the rules of the system.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.2 - but note this is not well followed"
},
{
"identity" : "rim",
"map" : "CV.displayName"
},
{
"identity" : "orim",
"map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
}
]
},
{
"id" : "Patient.animal.breed.coding.userSelected",
"path" : "Patient.animal.breed.coding.userSelected",
"short" : "If this coding was chosen directly by the user",
"definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"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.",
"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,
"max" : "1",
"base" : {
"path" : "Coding.userSelected",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "Sometimes implied by being first"
},
{
"identity" : "rim",
"map" : "CD.codingRationale"
},
{
"identity" : "orim",
"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 ]"
}
]
},
{
"id" : "Patient.animal.breed.text",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.animal.breed.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.",
"comment" : "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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"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" : "Patient.animal.genderStatus",
"path" : "Patient.animal.genderStatus",
"short" : "E.g. Neutered, Intact",
"definition" : "Indicates the current state of the animal's reproductive organs.",
"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.",
"requirements" : "Gender status can affect housing and animal behavior.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.animal.genderStatus",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "AnimalGenderStatus"
}
],
"strength" : "example",
"description" : "The state of the animal's reproductive organs.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/animal-genderstatus"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "N/A"
},
{
"identity" : "rim",
"map" : "genderStatusCode"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.animal.genderStatus.id",
"path" : "Patient.animal.genderStatus.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.animal.genderStatus.extension",
"path" : "Patient.animal.genderStatus.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.animal.genderStatus.coding",
"path" : "Patient.animal.genderStatus.coding",
"short" : "Code defined by a terminology system",
"definition" : "A reference to a code defined by a terminology system.",
"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.",
"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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity" : "rim",
"map" : "CV"
},
{
"identity" : "orim",
"map" : "fhir:Coding rdfs:subClassOf dt:CDCoding"
},
{
"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" : "Patient.animal.genderStatus.coding.id",
"path" : "Patient.animal.genderStatus.coding.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.animal.genderStatus.coding.extension",
"path" : "Patient.animal.genderStatus.coding.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.animal.genderStatus.coding.system",
"path" : "Patient.animal.genderStatus.coding.system",
"short" : "Identity of the terminology system",
"definition" : "The identification of the code system that defines the meaning of the symbol in the code.",
"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.",
"requirements" : "Need to be unambiguous about the source of the definition of the symbol.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.3"
},
{
"identity" : "rim",
"map" : "./codeSystem"
},
{
"identity" : "orim",
"map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id" : "Patient.animal.genderStatus.coding.version",
"path" : "Patient.animal.genderStatus.coding.version",
"short" : "Version of the system - if relevant",
"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.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.version",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.7"
},
{
"identity" : "rim",
"map" : "./codeSystemVersion"
},
{
"identity" : "orim",
"map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id" : "Patient.animal.genderStatus.coding.code",
"path" : "Patient.animal.genderStatus.coding.code",
"short" : "Symbol in syntax defined by the system",
"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).",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Need to refer to a particular code in the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.1"
},
{
"identity" : "rim",
"map" : "./code"
},
{
"identity" : "orim",
"map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id" : "Patient.animal.genderStatus.coding.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.animal.genderStatus.coding.display",
"short" : "Representation defined by the system",
"definition" : "A representation of the meaning of the code in the system, following the rules of the system.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.2 - but note this is not well followed"
},
{
"identity" : "rim",
"map" : "CV.displayName"
},
{
"identity" : "orim",
"map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
}
]
},
{
"id" : "Patient.animal.genderStatus.coding.userSelected",
"path" : "Patient.animal.genderStatus.coding.userSelected",
"short" : "If this coding was chosen directly by the user",
"definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"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.",
"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,
"max" : "1",
"base" : {
"path" : "Coding.userSelected",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "Sometimes implied by being first"
},
{
"identity" : "rim",
"map" : "CD.codingRationale"
},
{
"identity" : "orim",
"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 ]"
}
]
},
{
"id" : "Patient.animal.genderStatus.text",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.animal.genderStatus.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.",
"comment" : "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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"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" : "Patient.communication",
"path" : "Patient.communication",
"short" : "A list of Languages which may be used to communicate with the patient about his or her health",
"definition" : "Languages which may be used to communicate with the patient about his or her health.",
"comment" : "If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes then you need multiple Patient.Communication associations. For animals, language is not a relevant field, and should be absent from the instance. If the Patient does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.",
"requirements" : "If a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.communication",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "LanguageCommunication"
},
{
"identity" : "cda",
"map" : "patient.languageCommunication"
}
]
},
{
"id" : "Patient.communication.id",
"path" : "Patient.communication.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.communication.extension",
"path" : "Patient.communication.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.communication.modifierExtension",
"path" : "Patient.communication.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.",
"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.",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.communication.language",
"path" : "Patient.communication.language",
"short" : "The language which can be used to communicate with the patient about his or her health",
"definition" : "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English.",
"comment" : "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.",
"requirements" : "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.communication.language",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "CodeableConcept"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mustSupport" : true,
"binding" : {
"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
}
],
"strength" : "extensible",
"description" : "A human language.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/languages"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE"
},
{
"identity" : "rim",
"map" : "CD"
},
{
"identity" : "orim",
"map" : "fhir:CodeableConcept rdfs:subClassOf dt:CD"
},
{
"identity" : "v2",
"map" : "PID-15, LAN-2"
},
{
"identity" : "rim",
"map" : "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"
},
{
"identity" : "cda",
"map" : ".languageCode"
}
]
},
{
"id" : "Patient.communication.language.id",
"path" : "Patient.communication.language.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.communication.language.extension",
"path" : "Patient.communication.language.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.communication.language.coding",
"path" : "Patient.communication.language.coding",
"short" : "Code defined by a terminology system",
"definition" : "A reference to a code defined by a terminology system.",
"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.",
"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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CE/CNE/CWE subset one of the sets of component 1-3 or 4-6"
},
{
"identity" : "rim",
"map" : "CV"
},
{
"identity" : "orim",
"map" : "fhir:Coding rdfs:subClassOf dt:CDCoding"
},
{
"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" : "Patient.communication.language.coding.id",
"path" : "Patient.communication.language.coding.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.communication.language.coding.extension",
"path" : "Patient.communication.language.coding.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.communication.language.coding.system",
"path" : "Patient.communication.language.coding.system",
"short" : "Identity of the terminology system",
"definition" : "The identification of the code system that defines the meaning of the symbol in the code.",
"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.",
"requirements" : "Need to be unambiguous about the source of the definition of the symbol.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.system",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "uri"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.3"
},
{
"identity" : "rim",
"map" : "./codeSystem"
},
{
"identity" : "orim",
"map" : "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
}
]
},
{
"id" : "Patient.communication.language.coding.version",
"path" : "Patient.communication.language.coding.version",
"short" : "Version of the system - if relevant",
"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.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.version",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.7"
},
{
"identity" : "rim",
"map" : "./codeSystemVersion"
},
{
"identity" : "orim",
"map" : "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
}
]
},
{
"id" : "Patient.communication.language.coding.code",
"path" : "Patient.communication.language.coding.code",
"short" : "Symbol in syntax defined by the system",
"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).",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Need to refer to a particular code in the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.1"
},
{
"identity" : "rim",
"map" : "./code"
},
{
"identity" : "orim",
"map" : "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
}
]
},
{
"id" : "Patient.communication.language.coding.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.communication.language.coding.display",
"short" : "Representation defined by the system",
"definition" : "A representation of the meaning of the code in the system, following the rules of the system.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"requirements" : "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Coding.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "C*E.2 - but note this is not well followed"
},
{
"identity" : "rim",
"map" : "CV.displayName"
},
{
"identity" : "orim",
"map" : "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
}
]
},
{
"id" : "Patient.communication.language.coding.userSelected",
"path" : "Patient.communication.language.coding.userSelected",
"short" : "If this coding was chosen directly by the user",
"definition" : "Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).",
"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.",
"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,
"max" : "1",
"base" : {
"path" : "Coding.userSelected",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "Sometimes implied by being first"
},
{
"identity" : "rim",
"map" : "CD.codingRationale"
},
{
"identity" : "orim",
"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 ]"
}
]
},
{
"id" : "Patient.communication.language.text",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.communication.language.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.",
"comment" : "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"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"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" : "Patient.communication.preferred",
"path" : "Patient.communication.preferred",
"short" : "Language preference indicator",
"definition" : "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).",
"comment" : "This language is specifically identified for communicating healthcare information.",
"requirements" : "People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.communication.preferred",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "PID-15"
},
{
"identity" : "rim",
"map" : "preferenceInd"
},
{
"identity" : "cda",
"map" : ".preferenceInd"
}
]
},
{
"id" : "Patient.generalPractitioner",
"path" : "Patient.generalPractitioner",
"short" : "Patient's nominated primary care provider",
"definition" : "Patient's nominated care provider.",
"comment" : "This may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity setting, or even organization that will provide people to perform the care provider roles.
It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.",
"alias" : [
"careProvider"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.generalPractitioner",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Organization"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))",
"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, '#')])"
}
],
"mustSupport" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "v2",
"map" : "PD1-4"
},
{
"identity" : "rim",
"map" : "subjectOf.CareEvent.performer.AssignedEntity"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.generalPractitioner.id",
"path" : "Patient.generalPractitioner.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.generalPractitioner.extension",
"path" : "Patient.generalPractitioner.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.generalPractitioner.reference",
"path" : "Patient.generalPractitioner.reference",
"short" : "Literal reference, Relative, internal or absolute URL",
"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.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.reference",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1",
"ref-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.generalPractitioner.identifier",
"path" : "Patient.generalPractitioner.identifier",
"short" : "Logical reference, when literal reference is not known",
"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.",
"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.
When 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
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "Reference.identifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"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" : "servd",
"map" : "Identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
}
]
},
{
"id" : "Patient.generalPractitioner.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.generalPractitioner.display",
"short" : "Text alternative for the resource",
"definition" : "Plain text narrative that identifies the resource in addition to the resource reference.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.managingOrganization",
"path" : "Patient.managingOrganization",
"short" : "Organization that is the custodian of the patient record",
"definition" : "Organization that is the custodian of the patient record.",
"comment" : "There is only one managing organization for a specific patient record. Other organizations will have their own Patient record, and may use the Link property to join the records together (or a Person resource which can include confidence ratings for the association).",
"requirements" : "Need to know who recognizes this patient record, manages and updates it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Patient.managingOrganization",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))",
"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, '#')])"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "rim",
"map" : "scoper"
},
{
"identity" : "cda",
"map" : ".providerOrganization"
}
]
},
{
"id" : "Patient.managingOrganization.id",
"path" : "Patient.managingOrganization.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.managingOrganization.extension",
"path" : "Patient.managingOrganization.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.managingOrganization.reference",
"path" : "Patient.managingOrganization.reference",
"short" : "Literal reference, Relative, internal or absolute URL",
"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.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.reference",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1",
"ref-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.managingOrganization.identifier",
"path" : "Patient.managingOrganization.identifier",
"short" : "Logical reference, when literal reference is not known",
"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.",
"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.
When 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
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.identifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"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" : "servd",
"map" : "Identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
}
]
},
{
"id" : "Patient.managingOrganization.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.managingOrganization.display",
"short" : "Text alternative for the resource",
"definition" : "Plain text narrative that identifies the resource in addition to the resource reference.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.link",
"path" : "Patient.link",
"short" : "Link to another patient resource that concerns the same actual person",
"definition" : "Link to another patient resource that concerns the same actual patient.",
"comment" : "There is no assumption that linked patient records have mutual links.
This element is labelled as a modifier because it may not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'.",
"requirements" : "There are multiple usecases:
* Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, and * Distribution of patient information across multiple servers.",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Patient.link",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "BackboneElement"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "outboundLink"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.link.id",
"path" : "Patient.link.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.link.extension",
"path" : "Patient.link.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.link.modifierExtension",
"path" : "Patient.link.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.",
"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.",
"alias" : [
"extensions",
"user content",
"modifiers"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "BackboneElement.modifierExtension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"isModifier" : true,
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.link.other",
"path" : "Patient.link.other",
"short" : "The other patient or related person resource that the link refers to",
"definition" : "The other patient resource that the link refers to.",
"comment" : "Referencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.link.other",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/Patient"
},
{
"code" : "Reference",
"targetProfile" : "http://hl7.org/fhir/StructureDefinition/RelatedPerson"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ref-1",
"severity" : "error",
"human" : "SHALL have a contained resource if a local reference is provided",
"expression" : "reference.startsWith('#').not() or (reference.substring(1).trace('url') in %resource.contained.id.trace('ids'))",
"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, '#')])"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "The target of a resource reference is a RIM entry point (Act, Role, or Entity)"
},
{
"identity" : "v2",
"map" : "PID-3, MRG-1"
},
{
"identity" : "rim",
"map" : "id"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
},
{
"id" : "Patient.link.other.id",
"path" : "Patient.link.other.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.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Element.id",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Patient.link.other.extension",
"path" : "Patient.link.other.extension",
"slicing" : {
"discriminator" : [
{
"type" : "value",
"path" : "url"
}
],
"description" : "Extensions are always sliced by (at least) url",
"rules" : "open"
},
"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.",
"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.",
"alias" : [
"extensions",
"user content"
],
"min" : 0,
"max" : "*",
"base" : {
"path" : "Element.extension",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "Extension"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
},
{
"key" : "ext-1",
"severity" : "error",
"human" : "Must have either extensions or value[x], not both",
"expression" : "extension.exists() != value.exists()",
"xpath" : "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])"
}
],
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.link.other.reference",
"path" : "Patient.link.other.reference",
"short" : "Literal reference, Relative, internal or absolute URL",
"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.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.reference",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1",
"ref-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.link.other.identifier",
"path" : "Patient.link.other.identifier",
"short" : "Logical reference, when literal reference is not known",
"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.",
"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.
When 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
Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.identifier",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "Identifier"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "v2",
"map" : "CX / EI (occasionally, more often EI maps to a resource id or a URL)"
},
{
"identity" : "rim",
"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" : "servd",
"map" : "Identifier"
},
{
"identity" : "rim",
"map" : ".identifier"
}
]
},
{
"id" : "Patient.link.other.display",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean" : true
}
],
"path" : "Patient.link.other.display",
"short" : "Text alternative for the resource",
"definition" : "Plain text narrative that identifies the resource in addition to the resource reference.",
"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.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Reference.display",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "N/A"
}
]
},
{
"id" : "Patient.link.type",
"path" : "Patient.link.type",
"short" : "replaced-by | replaces | refer | seealso - type of link",
"definition" : "The type of link between this patient resource and another patient resource.",
"comment" : "Note that FHIR strings may not exceed 1MB in size",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Patient.link.type",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "code"
}
],
"condition" : [
"ele-1"
],
"constraint" : [
{
"key" : "ele-1",
"severity" : "error",
"human" : "All FHIR elements must have a @value or children",
"expression" : "hasValue() | (children().count() > id.count())",
"xpath" : "@value|f:*|h:div"
}
],
"isSummary" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "LinkType"
}
],
"strength" : "required",
"description" : "The type of link between this patient resource and another patient resource.",
"valueSetReference" : {
"reference" : "http://hl7.org/fhir/ValueSet/link-type"
}
},
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
},
{
"identity" : "rim",
"map" : "typeCode"
},
{
"identity" : "cda",
"map" : "n/a"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Patient.name",
"path" : "Patient.name",
"requirements" : "Need to be able to track the patient by multiple names. Examples are your official name and a partner name.
The Alphabetic representation of the name SHALL be always provided",
"mustSupport" : true
},
{
"id" : "Patient.name.family",
"path" : "Patient.name.family",
"min" : 1,
"mustSupport" : true
},
{
"id" : "Patient.name.given",
"path" : "Patient.name.given",
"min" : 1,
"max" : "1",
"mustSupport" : true
},
{
"id" : "Patient.telecom",
"path" : "Patient.telecom",
"mustSupport" : true
},
{
"id" : "Patient.gender",
"path" : "Patient.gender",
"min" : 1,
"mustSupport" : true
},
{
"id" : "Patient.birthDate",
"path" : "Patient.birthDate",
"min" : 1,
"mustSupport" : true
},
{
"id" : "Patient.address",
"path" : "Patient.address",
"mustSupport" : true
},
{
"id" : "Patient.address.line",
"path" : "Patient.address.line",
"mustSupport" : true
},
{
"id" : "Patient.address.city",
"path" : "Patient.address.city",
"mustSupport" : true
},
{
"id" : "Patient.address.state",
"path" : "Patient.address.state",
"mustSupport" : true
},
{
"id" : "Patient.address.postalCode",
"path" : "Patient.address.postalCode",
"mustSupport" : true
},
{
"id" : "Patient.address.country",
"path" : "Patient.address.country",
"comment" : "ISO 3166 3 letter codes can be used in place of a full country name.
Required for cross-border exchange of IPS",
"mustSupport" : true
},
{
"id" : "Patient.contact",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Contact"
}
],
"path" : "Patient.contact",
"mustSupport" : true
},
{
"id" : "Patient.contact.relationship",
"path" : "Patient.contact.relationship",
"type" : [
{
"code" : "CodeableConcept",
"profile" : "http://hl7.org/fhir/uv/ips/StructureDefinition/codeableconcept-uv-ips"
}
],
"mustSupport" : true,
"binding" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString" : "ContactRelationship"
}
],
"strength" : "required",
"valueSetUri" : "http://hl7.org/fhir/uv/ips/ValueSet/personal-relationship-uv-ips"
}
},
{
"id" : "Patient.contact.name",
"path" : "Patient.contact.name",
"mustSupport" : true
},
{
"id" : "Patient.contact.name.family",
"path" : "Patient.contact.name.family",
"mustSupport" : true
},
{
"id" : "Patient.contact.name.given",
"path" : "Patient.contact.name.given",
"mustSupport" : true
},
{
"id" : "Patient.contact.telecom",
"path" : "Patient.contact.telecom",
"mustSupport" : true
},
{
"id" : "Patient.contact.address",
"path" : "Patient.contact.address",
"mustSupport" : true
},
{
"id" : "Patient.contact.address.line",
"path" : "Patient.contact.address.line",
"mustSupport" : true
},
{
"id" : "Patient.contact.address.city",
"path" : "Patient.contact.address.city",
"mustSupport" : true
},
{
"id" : "Patient.contact.address.state",
"path" : "Patient.contact.address.state",
"mustSupport" : true
},
{
"id" : "Patient.contact.address.country",
"path" : "Patient.contact.address.country",
"mustSupport" : true
},
{
"id" : "Patient.contact.organization",
"path" : "Patient.contact.organization",
"mustSupport" : true
},
{
"id" : "Patient.contact.organization.identifier",
"path" : "Patient.contact.organization.identifier",
"max" : "0"
},
{
"id" : "Patient.animal",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-explicit-type-name",
"valueString" : "Animal"
}
],
"path" : "Patient.animal",
"max" : "0"
},
{
"id" : "Patient.communication",
"path" : "Patient.communication",
"mustSupport" : true
},
{
"id" : "Patient.communication.language",
"path" : "Patient.communication.language",
"mustSupport" : true
},
{
"id" : "Patient.generalPractitioner",
"path" : "Patient.generalPractitioner",
"mustSupport" : true
},
{
"id" : "Patient.generalPractitioner.identifier",
"path" : "Patient.generalPractitioner.identifier",
"max" : "0"
}
]
}
}
