DSTU2
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
StructureDefinition for Patient with expanded contact information
{
"resourceType": "StructureDefinition",
"id": "uslab-phpatient",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/uslab-phpatient",
"name": "US Laboratory Patient Profile",
"status": "draft",
"publisher": "Health Level Seven International (Orders and Observations - US Lab)",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://hl7.org"
}
]
}
],
"date": "2014-11-17",
"description": "Patient with expanded contact information",
"fhirVersion": "1.0.2",
"kind": "resource",
"constrainedType": "Patient",
"abstract": false,
"base": "http://hl7.org/fhir/StructureDefinition/Patient",
"snapshot": {
"element": [
{
"path": "Patient",
"name": "USLab-PHPatient",
"short": "Patient with expanded contact information",
"definition": "Subject of lab test.",
"alias": [
"SubjectOfCare Client Resident",
"Subject"
],
"min": 0,
"max": "*",
"base": {
"path": "Patient",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Patient"
}
],
"mapping": [
{
"identity": "cda",
"map": "ClinicalDocument.recordTarget.patientRole"
},
{
"identity": "rim",
"map": "Patient[classCode=PAT]"
},
{
"identity": "w5",
"map": "administrative.individual"
}
]
},
{
"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.",
"comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.",
"min": 0,
"max": "1",
"base": {
"path": "Patient.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"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": "Patient.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"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.",
"comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.",
"min": 0,
"max": "1",
"base": {
"path": "Patient.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"path": "Patient.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Patient.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
}
},
{
"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.",
"comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "Patient.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"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.",
"comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "Patient.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Patient.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.extension",
"name": "DAFRace",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "1",
"base": {
"path": "Patient.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/us-core-race"
]
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "Race of the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/daf-race"
}
}
},
{
"path": "Patient.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Extension.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.extension.extension",
"name": "extension",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"path": "Patient.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comments": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/us-core-race",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "A code classifying the person into a named category of humans sharing common history, traits, geographical origin or nationality.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-Race"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "CodeableConcept.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "CodeableConcept.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.coding",
"short": "Code defined by a terminology system",
"definition": "A reference to a code defined by a terminology system.",
"comments": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 1,
"max": "1",
"base": {
"path": "CodeableConcept.coding",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
},
{
"identity": "v2",
"map": "C*E.1-8, C*E.10-22"
},
{
"identity": "rim",
"map": "union(., ./translation)"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.coding.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Coding.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.coding.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Coding.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.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.",
"comments": "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": 1,
"max": "1",
"base": {
"path": "Coding.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
},
{
"identity": "v2",
"map": "C*E.3"
},
{
"identity": "rim",
"map": "./codeSystem"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.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.",
"comments": "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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
},
{
"identity": "v2",
"map": "C*E.7"
},
{
"identity": "rim",
"map": "./codeSystemVersion"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.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).",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"max": "1",
"base": {
"path": "Coding.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
},
{
"identity": "v2",
"map": "C*E.1"
},
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.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.",
"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"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
},
{
"identity": "v2",
"map": "C*E.2 - but note this is not well followed"
},
{
"identity": "rim",
"map": "CV.displayName"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.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).",
"comments": "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"
}
],
"isSummary": true,
"mapping": [
{
"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 ]"
},
{
"identity": "v2",
"map": "Sometimes implied by being first"
},
{
"identity": "rim",
"map": "CD.codingRationale"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.text",
"short": "Plain text representation of the concept",
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"comments": "Very often the text is the same as a displayName of one of the codings.",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"max": "1",
"base": {
"path": "CodeableConcept.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
},
{
"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"
}
]
},
{
"path": "Patient.extension",
"name": "DAFethnicity",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "1",
"base": {
"path": "Patient.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/us-core-ethnicity"
]
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "Ethnicity of the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/daf-ethnicity"
}
}
},
{
"path": "Patient.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Extension.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.extension.extension",
"name": "extension",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"path": "Patient.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comments": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #.",
"min": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/us-core-ethnicity",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept",
"short": "Value of extension",
"definition": "Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list).",
"min": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "A code classifying the person into a named category of humans sharing a common real or presumed heritage.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/v3-Ethnicity"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "CodeableConcept.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "CodeableConcept.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.coding",
"short": "Code defined by a terminology system",
"definition": "A reference to a code defined by a terminology system.",
"comments": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 1,
"max": "1",
"base": {
"path": "CodeableConcept.coding",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
},
{
"identity": "v2",
"map": "C*E.1-8, C*E.10-22"
},
{
"identity": "rim",
"map": "union(., ./translation)"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.coding.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Coding.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.coding.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Coding.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.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.",
"comments": "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": 1,
"max": "1",
"base": {
"path": "Coding.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
},
{
"identity": "v2",
"map": "C*E.3"
},
{
"identity": "rim",
"map": "./codeSystem"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.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.",
"comments": "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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
},
{
"identity": "v2",
"map": "C*E.7"
},
{
"identity": "rim",
"map": "./codeSystemVersion"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.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).",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"max": "1",
"base": {
"path": "Coding.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
},
{
"identity": "v2",
"map": "C*E.1"
},
{
"identity": "rim",
"map": "./code"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.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.",
"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"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
},
{
"identity": "v2",
"map": "C*E.2 - but note this is not well followed"
},
{
"identity": "rim",
"map": "CV.displayName"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.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).",
"comments": "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"
}
],
"isSummary": true,
"mapping": [
{
"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 ]"
},
{
"identity": "v2",
"map": "Sometimes implied by being first"
},
{
"identity": "rim",
"map": "CD.codingRationale"
}
]
},
{
"path": "Patient.extension.valueCodeableConcept.text",
"short": "Plain text representation of the concept",
"definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.",
"comments": "Very often the text is the same as a displayName of one of the codings.",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"max": "1",
"base": {
"path": "CodeableConcept.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
},
{
"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"
}
]
},
{
"path": "Patient.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Patient.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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": 1,
"max": "*",
"base": {
"path": "Patient.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".id"
},
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"map": "id"
},
{
"identity": "w5",
"map": "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).",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.identifier.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Identifier.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.identifier.use",
"short": "usual | official | temp | secondary (If known)",
"definition": "The purpose of this identifier.",
"comments": "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": 1,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"mustSupport": true,
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"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.",
"comments": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"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"
}
],
"isSummary": true,
"binding": {
"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": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"path": "Patient.identifier.system",
"short": "Organization or System URI",
"definition": "URI of Organization or system that assigned the patient ID. This may be the same as the Placer URI.",
"requirements": "There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"exampleUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri",
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"path": "Patient.identifier.value",
"short": "Patient Identifier String",
"definition": "Patient Identifier String.",
"comments": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.",
"min": 1,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"exampleString": "123456",
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"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"
}
]
},
{
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"path": "Patient.identifier.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comments": "The reference may be just a text description of the assigner.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"isSummary": true,
"mapping": [
{
"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"
}
]
},
{
"path": "Patient.active",
"short": "Whether this patient's record is in active use",
"definition": "Whether this patient record is in active use.",
"comments": "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.",
"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,
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "rim",
"map": "statusCode"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"path": "Patient.name",
"short": "A name associated with the patient",
"definition": "A name associated with the individual.",
"comments": "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.",
"min": 1,
"max": "*",
"base": {
"path": "Patient.name",
"min": 0,
"max": "*"
},
"type": [
{
"code": "HumanName"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".patient.name"
},
{
"identity": "v2",
"map": "PID-5, PID-9"
},
{
"identity": "rim",
"map": "name"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.name.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "HumanName.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.name.use",
"short": "usual | official | temp | nickname | anonymous | old | maiden",
"definition": "Identifies the purpose for this name.",
"comments": "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": 1,
"max": "1",
"base": {
"path": "HumanName.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"mustSupport": true,
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The name types for US Laboratory reporting to Public Health",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/uslab-patient-uslabph-nameuse"
}
},
"mapping": [
{
"identity": "v2",
"map": "XPN.7, but often indicated by which field contains the name"
},
{
"identity": "rim",
"map": "unique(./use)"
},
{
"identity": "servd",
"map": "./NamePurpose"
}
]
},
{
"path": "Patient.name.text",
"short": "Text representation of the full name",
"definition": "A full text representation of the name.",
"comments": "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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "implied by XPN.11"
},
{
"identity": "rim",
"map": "./formatted"
}
]
},
{
"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.",
"comments": "For family name, hyphenated names such as \"Smith-Jones\" are a single name, but names with spaces such as \"Smith Jones\" are broken into multiple parts.",
"alias": [
"surname"
],
"min": 1,
"max": "1",
"base": {
"path": "HumanName.family",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN.1"
},
{
"identity": "rim",
"map": "./part[partType = FAM]"
},
{
"identity": "servd",
"map": "./FamilyName"
}
]
},
{
"path": "Patient.name.given",
"short": "Given names (not always 'first'). Includes middle names",
"definition": "Given name.",
"comments": "Can be first and middle name or initial.",
"alias": [
"first name",
"middle name"
],
"min": 0,
"max": "2",
"base": {
"path": "HumanName.given",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN.2 + XPN.3"
},
{
"identity": "rim",
"map": "./part[partType = GIV]"
},
{
"identity": "servd",
"map": "./GivenNames"
}
]
},
{
"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.",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.prefix",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN.5"
},
{
"identity": "rim",
"map": "./part[partType = PFX]"
},
{
"identity": "servd",
"map": "./TitleCode"
}
]
},
{
"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.",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.suffix",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN/4"
},
{
"identity": "rim",
"map": "./part[partType = SFX]"
}
]
},
{
"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.",
"requirements": "Allows names to be placed in historical context.",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN.13 + XPN.14"
},
{
"identity": "rim",
"map": "./usablePeriod[type=\"IVL<TS>\"]"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"path": "Patient.telecom",
"slicing": {
"discriminator": [
"use"
],
"ordered": false,
"rules": "open"
},
"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.",
"comments": "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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".telecom"
},
{
"identity": "v2",
"map": "PID-13, PID-14, PID-40"
},
{
"identity": "rim",
"map": "telecom"
}
]
},
{
"path": "Patient.telecom",
"name": "USLabHomePhone",
"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.",
"comments": "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"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".telecom"
},
{
"identity": "v2",
"map": "PID-13, PID-14, PID-40"
},
{
"identity": "rim",
"map": "telecom"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.telecom.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "ContactPoint.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.telecom.system",
"short": "phone | fax | email | pager | other",
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"min": 1,
"max": "1",
"base": {
"path": "ContactPoint.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"cpt-2"
],
"mustSupport": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Telecommunications form for contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-system"
}
},
"mapping": [
{
"identity": "v2",
"map": "XTN.3"
},
{
"identity": "rim",
"map": "./scheme"
},
{
"identity": "servd",
"map": "./ContactPointType"
}
]
},
{
"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).",
"comments": "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": 1,
"max": "1",
"base": {
"path": "ContactPoint.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XTN.1 (or XTN.12)"
},
{
"identity": "rim",
"map": "./url"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"path": "Patient.telecom.use",
"short": "home | work | temp | old | mobile - purpose of this contact point",
"definition": "Identifies the purpose for the contact point.",
"comments": "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": 1,
"max": "1",
"base": {
"path": "ContactPoint.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"fixedCode": "home",
"mustSupport": true,
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Use of contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-use"
}
},
"mapping": [
{
"identity": "v2",
"map": "XTN.2 - but often indicated by field"
},
{
"identity": "rim",
"map": "unique(./use)"
},
{
"identity": "servd",
"map": "./ContactPointPurpose"
}
]
},
{
"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.",
"comments": "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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./useablePeriod[type=\"IVL<TS>\"]"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"path": "Patient.telecom",
"name": "USLabWorkPhone",
"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.",
"comments": "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"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".telecom"
},
{
"identity": "v2",
"map": "PID-13, PID-14, PID-40"
},
{
"identity": "rim",
"map": "telecom"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.telecom.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "ContactPoint.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.telecom.system",
"short": "phone | fax | email | pager | other",
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"min": 1,
"max": "1",
"base": {
"path": "ContactPoint.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"cpt-2"
],
"mustSupport": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Telecommunications form for contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-system"
}
},
"mapping": [
{
"identity": "v2",
"map": "XTN.3"
},
{
"identity": "rim",
"map": "./scheme"
},
{
"identity": "servd",
"map": "./ContactPointType"
}
]
},
{
"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).",
"comments": "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": 1,
"max": "1",
"base": {
"path": "ContactPoint.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XTN.1 (or XTN.12)"
},
{
"identity": "rim",
"map": "./url"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"path": "Patient.telecom.use",
"short": "home | work | temp | old | mobile - purpose of this contact point",
"definition": "Identifies the purpose for the contact point.",
"comments": "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": 1,
"max": "1",
"base": {
"path": "ContactPoint.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"fixedCode": "work",
"mustSupport": true,
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Use of contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-use"
}
},
"mapping": [
{
"identity": "v2",
"map": "XTN.2 - but often indicated by field"
},
{
"identity": "rim",
"map": "unique(./use)"
},
{
"identity": "servd",
"map": "./ContactPointPurpose"
}
]
},
{
"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.",
"comments": "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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./useablePeriod[type=\"IVL<TS>\"]"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"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.",
"comments": "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"
}
],
"mustSupport": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The gender of a person used for administrative purposes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
"mapping": [
{
"identity": "cda",
"map": ".patient.administrativeGenderCode"
},
{
"identity": "v2",
"map": "PID-8"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
}
]
},
{
"path": "Patient.birthDate",
"short": "The date of birth for the individual",
"definition": "The date of birth for the individual.",
"comments": "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": 0,
"max": "1",
"base": {
"path": "Patient.birthDate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "date"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "loinc",
"map": "21112-8"
},
{
"identity": "cda",
"map": ".patient.birthTime"
},
{
"identity": "v2",
"map": "PID-7"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime"
}
]
},
{
"path": "Patient.deceased[x]",
"short": "Indicates if the individual is deceased or not",
"definition": "Indicates if the individual is deceased or not.",
"comments": "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.",
"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"
}
],
"mustSupport": true,
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "cda",
"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"
}
]
},
{
"path": "Patient.address",
"short": "Addresses for the individual",
"definition": "Addresses for the individual.",
"comments": "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"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".addr"
},
{
"identity": "v2",
"map": "PID-11"
},
{
"identity": "rim",
"map": "addr"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Address.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.address.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Address.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.address.extension",
"name": "USLabPHCountry",
"short": "County/Parish FIPS codes",
"definition": "County/Parish FIPS codes.",
"requirements": "County/Parish Code SHALL use FIPS 6-4 ( INCITS 31:2009).",
"min": 0,
"max": "1",
"base": {
"path": "Address.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/us-core-county"
]
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "FIPS codes for US counties and county equivalent entities.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/fips-county"
}
}
},
{
"path": "Patient.address.use",
"short": "home | work | temp | old - purpose of this address",
"definition": "The purpose of this address.",
"comments": "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"
}
],
"exampleCode": "home",
"mustSupport": true,
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The use of an address",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/address-use"
}
},
"mapping": [
{
"identity": "v2",
"map": "XAD.7"
},
{
"identity": "rim",
"map": "unique(./use)"
},
{
"identity": "servd",
"map": "./AddressPurpose"
}
]
},
{
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Address.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"exampleCode": "both",
"isSummary": true,
"binding": {
"strength": "required",
"description": "The type of an address (physical / postal)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/address-type"
}
},
"mapping": [
{
"identity": "vcard",
"map": "address type parameter"
},
{
"identity": "v2",
"map": "XAD.18"
},
{
"identity": "rim",
"map": "unique(./use)"
}
]
},
{
"path": "Patient.address.text",
"short": "Text representation of the address",
"definition": "A full text representation of the address.",
"comments": "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"
}
],
"exampleString": "137 Nowhere Street, Erewhon 9132",
"isSummary": true,
"mapping": [
{
"identity": "vcard",
"map": "address label parameter"
},
{
"identity": "v2",
"map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6"
},
{
"identity": "rim",
"map": "./formatted"
}
]
},
{
"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.",
"requirements": "home | work | temp | old - purpose of this address.",
"min": 0,
"max": "2",
"base": {
"path": "Address.line",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"exampleString": "137 Nowhere Street",
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "vcard",
"map": "street"
},
{
"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": "servd",
"map": "./StreetAddress (newline delimitted)"
}
]
},
{
"path": "Patient.address.city",
"short": "Name of city, town etc.",
"definition": "The name of the city, town, village or other community or delivery center.",
"alias": [
"Municpality"
],
"min": 0,
"max": "1",
"base": {
"path": "Address.city",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"exampleString": "Erewhon",
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "vcard",
"map": "locality"
},
{
"identity": "v2",
"map": "XAD.3"
},
{
"identity": "rim",
"map": "AD.part[parttype = CTY]"
},
{
"identity": "servd",
"map": "./Jurisdiction"
}
]
},
{
"path": "Patient.address.district",
"short": "District name (aka county)",
"definition": "The name of the administrative area (county).",
"comments": "District is sometimes known as county, but in some regions 'county' in 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"
}
],
"exampleString": "Madison",
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XAD.9"
},
{
"identity": "rim",
"map": "AD.part[parttype = CNT | CPA]"
}
]
},
{
"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).",
"requirements": "State SHALL be the two letter USPS alphabetic codes.",
"alias": [
"Province",
"Territory"
],
"min": 0,
"max": "1",
"base": {
"path": "Address.state",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Two letter USPS alphabetic codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/usps-state"
}
},
"mapping": [
{
"identity": "vcard",
"map": "region"
},
{
"identity": "v2",
"map": "XAD.4"
},
{
"identity": "rim",
"map": "AD.part[parttype = STA]"
},
{
"identity": "servd",
"map": "./Region"
}
]
},
{
"path": "Patient.address.postalCode",
"short": "US Zip Codes",
"definition": "US Zip Codes.",
"requirements": "Zip or Postal Code SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes.",
"alias": [
"Zip"
],
"min": 0,
"max": "1",
"base": {
"path": "Address.postalCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"exampleString": "9132",
"constraint": [
{
"key": "inv-1",
"severity": "error",
"human": "(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.",
"xpath": "f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "vcard",
"map": "code"
},
{
"identity": "v2",
"map": "XAD.5"
},
{
"identity": "rim",
"map": "AD.part[parttype = ZIP]"
},
{
"identity": "servd",
"map": "./PostalIdentificationCode"
}
]
},
{
"path": "Patient.address.country",
"short": "ISO 3166 3 letter Country Code",
"definition": "ISO 3166 3 letter Country Code.",
"comments": "ISO 3166 3 letter codes can be used in place of a full country name.",
"requirements": "Country SHALL be ISO 3166 3 letter codes.",
"min": 0,
"max": "1",
"base": {
"path": "Address.country",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "ISO 2 letter country codes.",
"valueSetUri": "http://www.iso.org/iso/country_codes.htm"
},
"mapping": [
{
"identity": "vcard",
"map": "country"
},
{
"identity": "v2",
"map": "XAD.6"
},
{
"identity": "rim",
"map": "AD.part[parttype = CNT]"
},
{
"identity": "servd",
"map": "./Country"
}
]
},
{
"path": "Patient.address.period",
"short": "Time period when address was/is in use",
"definition": "Time period when address was/is in use.",
"requirements": "Allows addresses to be placed in historical context.",
"min": 0,
"max": "1",
"base": {
"path": "Address.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"examplePeriod": {
"start": "2010-03-23",
"end": "2010-07-01"
},
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XAD.12 / XAD.13 + XAD.14"
},
{
"identity": "rim",
"map": "./usablePeriod[type=\"IVL<TS>\"]"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"path": "Patient.maritalStatus",
"short": "Marital (civil) status of a patient",
"definition": "This field contains a patient's most recent marital (civil) status.",
"requirements": "Most, if not all systems capture it.",
"min": 0,
"max": "1",
"base": {
"path": "Patient.maritalStatus",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"description": "The domestic partnership status of a person.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/marital-status"
}
},
"mapping": [
{
"identity": "cda",
"map": ".patient.maritalStatusCode"
},
{
"identity": "v2",
"map": "PID-16"
},
{
"identity": "rim",
"map": "player[classCode=PSN]/maritalStatusCode"
}
]
},
{
"path": "Patient.multipleBirth[x]",
"short": "Whether patient is part of a multiple birth",
"definition": "Indicates whether the patient is part of a multiple or indicates the actual birth order.",
"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"
}
],
"mapping": [
{
"identity": "cda",
"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"
}
]
},
{
"path": "Patient.photo",
"short": "Image of the patient",
"definition": "Image of the patient.",
"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"
}
],
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "v2",
"map": "OBX-5 - needs a profile"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"
}
]
},
{
"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.",
"comments": "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"
}
],
"constraint": [
{
"key": "pat-1",
"severity": "error",
"human": "SHALL at least contain a contact's details or a reference to an organization",
"xpath": "f:name or f:telecom or f:address or f:organization"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Patient.contact.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.contact.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Patient.contact.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "Patient.contact.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.contact.relationship",
"short": "The kind of relationship",
"definition": "The nature of the relationship between the patient and the contact person.",
"requirements": "Used to determine which contact person is the most relevant to approach, depending on circumstances.",
"min": 0,
"max": "1",
"base": {
"path": "Patient.contact.relationship",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"strength": "extensible",
"description": "The nature of the relationship between a patient and a contact person for that patient.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/patient-contact-relationship"
}
},
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "v2",
"map": "NK1-7, NK1-3"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "CodeableConcept.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.contact.relationship.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "CodeableConcept.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.contact.relationship.coding",
"short": "Code defined by a terminology system",
"definition": "A reference to a code defined by a terminology system.",
"comments": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.",
"requirements": "Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.",
"min": 1,
"max": "1",
"base": {
"path": "CodeableConcept.coding",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding"
},
{
"identity": "v2",
"map": "C*E.1-8, C*E.10-22"
},
{
"identity": "rim",
"map": "union(., ./translation)"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Coding.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.contact.relationship.coding.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Coding.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"comments": "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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem"
},
{
"identity": "v2",
"map": "C*E.3"
},
{
"identity": "rim",
"map": "./codeSystem"
}
]
},
{
"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.",
"comments": "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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion"
},
{
"identity": "v2",
"map": "C*E.7"
},
{
"identity": "rim",
"map": "./codeSystemVersion"
}
]
},
{
"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).",
"requirements": "Need to refer to a particular code in the system.",
"min": 1,
"max": "1",
"base": {
"path": "Coding.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code"
},
{
"identity": "v2",
"map": "C*E.1"
},
{
"identity": "rim",
"map": "./code"
}
]
},
{
"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.",
"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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName"
},
{
"identity": "v2",
"map": "C*E.2 - but note this is not well followed"
},
{
"identity": "rim",
"map": "CV.displayName"
}
]
},
{
"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).",
"comments": "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"
}
],
"isSummary": true,
"mapping": [
{
"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 ]"
},
{
"identity": "v2",
"map": "Sometimes implied by being first"
},
{
"identity": "rim",
"map": "CD.codingRationale"
}
]
},
{
"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.",
"comments": "Very often the text is the same as a displayName of one of the codings.",
"requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.",
"min": 0,
"max": "1",
"base": {
"path": "CodeableConcept.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "orim",
"map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText"
},
{
"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"
}
]
},
{
"path": "Patient.contact.name",
"short": "A name associated with the contact person",
"definition": "A name associated with the contact person.",
"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"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "v2",
"map": "NK1-2"
},
{
"identity": "rim",
"map": "name"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.contact.name.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "HumanName.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.contact.name.use",
"short": "usual | official | temp | nickname | anonymous | old | maiden",
"definition": "Identifies the purpose for this name.",
"comments": "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"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The use of a human name",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/name-use"
}
},
"mapping": [
{
"identity": "v2",
"map": "XPN.7, but often indicated by which field contains the name"
},
{
"identity": "rim",
"map": "unique(./use)"
},
{
"identity": "servd",
"map": "./NamePurpose"
}
]
},
{
"path": "Patient.contact.name.text",
"short": "Text representation of the full name",
"definition": "A full text representation of the name.",
"comments": "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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "implied by XPN.11"
},
{
"identity": "rim",
"map": "./formatted"
}
]
},
{
"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.",
"comments": "For family name, hyphenated names such as \"Smith-Jones\" are a single name, but names with spaces such as \"Smith Jones\" are broken into multiple parts.",
"alias": [
"surname"
],
"min": 1,
"max": "1",
"base": {
"path": "HumanName.family",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN.1"
},
{
"identity": "rim",
"map": "./part[partType = FAM]"
},
{
"identity": "servd",
"map": "./FamilyName"
}
]
},
{
"path": "Patient.contact.name.given",
"short": "Given names (not always 'first'). Includes middle names",
"definition": "Given name.",
"comments": "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": "2",
"base": {
"path": "HumanName.given",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN.2 + XPN.3"
},
{
"identity": "rim",
"map": "./part[partType = GIV]"
},
{
"identity": "servd",
"map": "./GivenNames"
}
]
},
{
"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.",
"min": 0,
"max": "*",
"base": {
"path": "HumanName.prefix",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN.5"
},
{
"identity": "rim",
"map": "./part[partType = PFX]"
},
{
"identity": "servd",
"map": "./TitleCode"
}
]
},
{
"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.",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.suffix",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN/4"
},
{
"identity": "rim",
"map": "./part[partType = SFX]"
}
]
},
{
"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.",
"requirements": "Allows names to be placed in historical context.",
"min": 0,
"max": "1",
"base": {
"path": "HumanName.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XPN.13 + XPN.14"
},
{
"identity": "rim",
"map": "./usablePeriod[type=\"IVL<TS>\"]"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"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.",
"comments": "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": "3",
"base": {
"path": "Patient.contact.telecom",
"min": 0,
"max": "*"
},
"type": [
{
"code": "ContactPoint"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "v2",
"map": "NK1-5, NK1-6, NK1-40"
},
{
"identity": "rim",
"map": "telecom"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.contact.telecom.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "ContactPoint.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.contact.telecom.system",
"short": "phone | fax | email | pager | other",
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"min": 1,
"max": "1",
"base": {
"path": "ContactPoint.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"condition": [
"cpt-2"
],
"mustSupport": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Telecommunications form for contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-system"
}
},
"mapping": [
{
"identity": "v2",
"map": "XTN.3"
},
{
"identity": "rim",
"map": "./scheme"
},
{
"identity": "servd",
"map": "./ContactPointType"
}
]
},
{
"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).",
"comments": "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": 1,
"max": "1",
"base": {
"path": "ContactPoint.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XTN.1 (or XTN.12)"
},
{
"identity": "rim",
"map": "./url"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"path": "Patient.contact.telecom.use",
"short": "home | work | temp | old | mobile - purpose of this contact point",
"definition": "Identifies the purpose for the contact point.",
"comments": "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"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Use of contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/contact-point-use"
}
},
"mapping": [
{
"identity": "v2",
"map": "XTN.2 - but often indicated by field"
},
{
"identity": "rim",
"map": "unique(./use)"
},
{
"identity": "servd",
"map": "./ContactPointPurpose"
}
]
},
{
"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.",
"comments": "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"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "n/a"
},
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"min": 0,
"max": "1",
"base": {
"path": "ContactPoint.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "./useablePeriod[type=\"IVL<TS>\"]"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"path": "Patient.contact.address",
"short": "Address for the contact person",
"definition": "Address for the contact person.",
"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"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "v2",
"map": "NK1-4"
},
{
"identity": "rim",
"map": "addr"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Address.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.contact.address.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Address.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.contact.address.extension",
"name": "CountyCountact",
"short": "County/Parish FIPS codes",
"definition": "County/Parish FIPS codes.",
"requirements": "County/Parish Code SHALL use FIPS 6-4 ( INCITS 31:2009).",
"min": 0,
"max": "1",
"base": {
"path": "Address.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/us-core-county"
]
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "FIPS codes for US counties and county equivalent entities.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/fips-county"
}
}
},
{
"path": "Patient.contact.address.use",
"short": "home | work | temp | old - purpose of this address",
"definition": "The purpose of this address.",
"comments": "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": 1,
"max": "1",
"base": {
"path": "Address.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"exampleCode": "home",
"mustSupport": true,
"isModifier": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "The use of an address",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/address-use"
}
},
"mapping": [
{
"identity": "v2",
"map": "XAD.7"
},
{
"identity": "rim",
"map": "unique(./use)"
},
{
"identity": "servd",
"map": "./AddressPurpose"
}
]
},
{
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Address.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"exampleCode": "both",
"isSummary": true,
"binding": {
"strength": "required",
"description": "The type of an address (physical / postal)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/address-type"
}
},
"mapping": [
{
"identity": "vcard",
"map": "address type parameter"
},
{
"identity": "v2",
"map": "XAD.18"
},
{
"identity": "rim",
"map": "unique(./use)"
}
]
},
{
"path": "Patient.contact.address.text",
"short": "Text representation of the address",
"definition": "A full text representation of the address.",
"comments": "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"
}
],
"exampleString": "137 Nowhere Street, Erewhon 9132",
"isSummary": true,
"mapping": [
{
"identity": "vcard",
"map": "address label parameter"
},
{
"identity": "v2",
"map": "XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6"
},
{
"identity": "rim",
"map": "./formatted"
}
]
},
{
"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.",
"requirements": "home | work | temp | old - purpose of this address.",
"min": 0,
"max": "2",
"base": {
"path": "Address.line",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
],
"exampleString": "137 Nowhere Street",
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "vcard",
"map": "street"
},
{
"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": "servd",
"map": "./StreetAddress (newline delimitted)"
}
]
},
{
"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.",
"alias": [
"Municpality"
],
"min": 0,
"max": "1",
"base": {
"path": "Address.city",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"exampleString": "Erewhon",
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "vcard",
"map": "locality"
},
{
"identity": "v2",
"map": "XAD.3"
},
{
"identity": "rim",
"map": "AD.part[parttype = CTY]"
},
{
"identity": "servd",
"map": "./Jurisdiction"
}
]
},
{
"path": "Patient.contact.address.district",
"short": "District name (aka county)",
"definition": "The name of the administrative area (county).",
"comments": "District is sometimes known as county, but in some regions 'county' in 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"
}
],
"exampleString": "Madison",
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XAD.9"
},
{
"identity": "rim",
"map": "AD.part[parttype = CNT | CPA]"
}
]
},
{
"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).",
"requirements": "State SHALL be the two letter USPS alphabetic codes.",
"alias": [
"Province",
"Territory"
],
"min": 0,
"max": "1",
"base": {
"path": "Address.state",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "Two letter USPS alphabetic codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/usps-state"
}
},
"mapping": [
{
"identity": "vcard",
"map": "region"
},
{
"identity": "v2",
"map": "XAD.4"
},
{
"identity": "rim",
"map": "AD.part[parttype = STA]"
},
{
"identity": "servd",
"map": "./Region"
}
]
},
{
"path": "Patient.contact.address.postalCode",
"short": "US Zip Codes",
"definition": "US Zip Codes.",
"requirements": "Zip or Postal Code SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes.",
"alias": [
"Zip"
],
"min": 0,
"max": "1",
"base": {
"path": "Address.postalCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"exampleString": "9132",
"constraint": [
{
"key": "inv-2",
"severity": "error",
"human": "(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.",
"xpath": "f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "vcard",
"map": "code"
},
{
"identity": "v2",
"map": "XAD.5"
},
{
"identity": "rim",
"map": "AD.part[parttype = ZIP]"
},
{
"identity": "servd",
"map": "./PostalIdentificationCode"
}
]
},
{
"path": "Patient.contact.address.country",
"short": "ISO 3166 3 letter Country Code",
"definition": "ISO 3166 3 letter Country Code.",
"comments": "ISO 3166 3 letter codes can be used in place of a full country name.",
"requirements": "Country SHALL be ISO 3166 3 letter codes.",
"min": 0,
"max": "1",
"base": {
"path": "Address.country",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"isSummary": true,
"binding": {
"strength": "required",
"description": "ISO 2 letter country codes.",
"valueSetUri": "http://www.iso.org/iso/country_codes.htm"
},
"mapping": [
{
"identity": "vcard",
"map": "country"
},
{
"identity": "v2",
"map": "XAD.6"
},
{
"identity": "rim",
"map": "AD.part[parttype = CNT]"
},
{
"identity": "servd",
"map": "./Country"
}
]
},
{
"path": "Patient.contact.address.period",
"short": "Time period when address was/is in use",
"definition": "Time period when address was/is in use.",
"requirements": "Allows addresses to be placed in historical context.",
"min": 0,
"max": "1",
"base": {
"path": "Address.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"examplePeriod": {
"start": "2010-03-23",
"end": "2010-07-01"
},
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "XAD.12 / XAD.13 + XAD.14"
},
{
"identity": "rim",
"map": "./usablePeriod[type=\"IVL<TS>\"]"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"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.",
"requirements": "Needed to address the person correctly.",
"min": 0,
"max": "1",
"base": {
"path": "Patient.contact.gender",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"description": "The gender of a person used for administrative purposes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "v2",
"map": "NK1-15"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender"
}
]
},
{
"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.",
"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",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"condition": [
"pat-1"
],
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "v2",
"map": "NK1-13, NK1-30, NK1-31, NK1-32, NK1-41"
},
{
"identity": "rim",
"map": "scoper"
}
]
},
{
"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.",
"min": 0,
"max": "1",
"base": {
"path": "Patient.contact.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "rim",
"map": "effectiveTime"
}
]
},
{
"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.",
"comments": "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": "1",
"base": {
"path": "Patient.animal",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "rim",
"map": "player[classCode=ANM]"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Patient.animal.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.animal.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Patient.animal.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "Patient.animal.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.animal.species",
"short": "E.g. Dog, Cow",
"definition": "Identifies the high level taxonomic categorization of the kind of animal.",
"comments": "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"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "The species of an animal.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/animal-species"
}
},
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "v2",
"map": "PID-35"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"path": "Patient.animal.breed",
"short": "E.g. Poodle, Angus",
"definition": "Identifies the detailed categorization of the kind of animal.",
"comments": "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"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "The breed of an animal.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/animal-breeds"
}
},
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "v2",
"map": "PID-37"
},
{
"identity": "rim",
"map": "playedRole[classCode=GEN]/scoper[classCode=ANM, determinerCode=KIND]/code"
}
]
},
{
"path": "Patient.animal.genderStatus",
"short": "E.g. Neutered, Intact",
"definition": "Indicates the current state of the animal's reproductive organs.",
"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"
}
],
"isSummary": true,
"binding": {
"strength": "example",
"description": "The state of the animal's reproductive organs.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/animal-genderstatus"
}
},
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "genderStatusCode"
}
]
},
{
"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.",
"comments": "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"
}
],
"mapping": [
{
"identity": "cda",
"map": "patient.languageCommunication"
},
{
"identity": "rim",
"map": "LanguageCommunication"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Patient.communication.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.communication.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Patient.communication.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "Patient.communication.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"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.",
"comments": "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"
}
],
"binding": {
"strength": "required",
"description": "A human language.",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
},
"mapping": [
{
"identity": "cda",
"map": ".languageCode"
},
{
"identity": "v2",
"map": "PID-15, LAN-2"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code"
}
]
},
{
"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).",
"comments": "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"
}
],
"mapping": [
{
"identity": "cda",
"map": ".preferenceInd"
},
{
"identity": "v2",
"map": "PID-15"
},
{
"identity": "rim",
"map": "preferenceInd"
}
]
},
{
"path": "Patient.careProvider",
"short": "Patient's nominated primary care provider",
"definition": "Patient's nominated care provider.",
"comments": "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.\n\nThis is not to be used to record Care Teams, these should be recorded on either the CarePlan or EpisodeOfCare resources.",
"min": 0,
"max": "*",
"base": {
"path": "Patient.careProvider",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
},
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Practitioner"
]
}
],
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "v2",
"map": "PD1-4"
},
{
"identity": "rim",
"map": "subjectOf.CareEvent.performer.AssignedEntity"
}
]
},
{
"path": "Patient.managingOrganization",
"short": "Organization that is the custodian of the patient record",
"definition": "Organization that is the custodian of the patient record.",
"comments": "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",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Organization"
]
}
],
"isSummary": true,
"mapping": [
{
"identity": "cda",
"map": ".providerOrganization"
},
{
"identity": "rim",
"map": "scoper"
}
]
},
{
"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.",
"comments": "There is no assumption that linked patient records have mutual links.",
"requirements": "There are multiple usecases: \n\n* 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"
}
],
"isModifier": true,
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "rim",
"map": "outboundLink"
}
]
},
{
"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).",
"min": 0,
"max": "1",
"base": {
"path": "Patient.link.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.link.extension",
"short": "Additional Content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Patient.link.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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.",
"comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "Patient.link.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.link.other",
"short": "The other patient resource that the link refers to",
"definition": "The other patient resource that the link refers to.",
"min": 1,
"max": "1",
"base": {
"path": "Patient.link.other",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"profile": [
"http://hl7.org/fhir/StructureDefinition/Patient"
]
}
],
"isModifier": true,
"mapping": [
{
"identity": "cda",
"map": "n/a"
},
{
"identity": "v2",
"map": "PID-3, MRG-1"
},
{
"identity": "rim",
"map": "id"
}
]
},
{
"path": "Patient.link.type",
"short": "replace | refer | seealso - type of link",
"definition": "The type of link between this patient resource and another patient resource.",
"min": 1,
"max": "1",
"base": {
"path": "Patient.link.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"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": "cda",
"map": "n/a"
},
{
"identity": "rim",
"map": "typeCode"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Patient",
"name": "USLab-PHPatient",
"short": "Patient with expanded contact information",
"definition": "Subject of lab test.",
"alias": [
"Subject"
],
"min": 0,
"max": "*",
"type": [
{
"code": "Patient"
}
]
},
{
"path": "Patient.extension",
"name": "DAFRace",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/us-core-race"
]
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "Race of the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/daf-race"
}
}
},
{
"path": "Patient.extension.valueCodeableConcept",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.extension.valueCodeableConcept.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.extension.valueCodeableConcept.coding.system",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.extension.valueCodeableConcept.coding.code",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.extension.valueCodeableConcept.coding.display",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.extension",
"name": "DAFethnicity",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/us-core-ethnicity"
]
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "Ethnicity of the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/daf-ethnicity"
}
}
},
{
"path": "Patient.extension.valueCodeableConcept",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.extension.valueCodeableConcept.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.extension.valueCodeableConcept.coding.system",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.extension.valueCodeableConcept.coding.code",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.extension.valueCodeableConcept.coding.display",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.identifier",
"min": 1,
"max": "*",
"mustSupport": true
},
{
"path": "Patient.identifier.use",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.identifier.system",
"short": "Organization or System URI",
"definition": "URI of Organization or system that assigned the patient ID. This may be the same as the Placer URI.",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.identifier.value",
"short": "Patient Identifier String",
"definition": "Patient Identifier String.",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.name",
"min": 1,
"max": "*",
"mustSupport": true
},
{
"path": "Patient.name.use",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "The name types for US Laboratory reporting to Public Health",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/uslab-patient-uslabph-nameuse"
}
}
},
{
"path": "Patient.name.family",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.name.given",
"comments": "Can be first and middle name or initial.",
"min": 0,
"max": "2",
"mustSupport": true
},
{
"path": "Patient.name.prefix",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.name.suffix",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.telecom",
"name": "USLabHomePhone",
"slicing": {
"discriminator": [
"use"
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*",
"mustSupport": true
},
{
"path": "Patient.telecom.system",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.telecom.value",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.telecom.use",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"fixedCode": "home",
"mustSupport": true
},
{
"path": "Patient.telecom",
"name": "USLabWorkPhone",
"min": 0,
"max": "*",
"mustSupport": true
},
{
"path": "Patient.telecom.system",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.telecom.value",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.telecom.use",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"fixedCode": "work",
"mustSupport": true
},
{
"path": "Patient.gender",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.birthDate",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.deceased[x]",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.address",
"min": 0,
"max": "*",
"mustSupport": true
},
{
"path": "Patient.address.extension",
"name": "USLabPHCountry",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
},
"short": "County/Parish FIPS codes",
"definition": "County/Parish FIPS codes.",
"requirements": "County/Parish Code SHALL use FIPS 6-4 ( INCITS 31:2009).",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/us-core-county"
]
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "FIPS codes for US counties and county equivalent entities.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/fips-county"
}
}
},
{
"path": "Patient.address.use",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.address.line",
"min": 0,
"max": "2",
"mustSupport": true
},
{
"path": "Patient.address.city",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.address.state",
"requirements": "State SHALL be the two letter USPS alphabetic codes.",
"min": 0,
"max": "1",
"mustSupport": true,
"binding": {
"strength": "required",
"description": "Two letter USPS alphabetic codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/usps-state"
}
}
},
{
"path": "Patient.address.postalCode",
"short": "US Zip Codes",
"definition": "US Zip Codes.",
"requirements": "Zip or Postal Code SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes.",
"min": 0,
"max": "1",
"condition": [
"inv-1"
],
"constraint": [
{
"key": "inv-1",
"severity": "error",
"human": "(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.",
"xpath": "f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )"
}
],
"mustSupport": true
},
{
"path": "Patient.address.country",
"short": "ISO 3166 3 letter Country Code",
"definition": "ISO 3166 3 letter Country Code.",
"requirements": "Country SHALL be ISO 3166 3 letter codes.",
"min": 0,
"max": "1",
"mustSupport": true,
"binding": {
"strength": "required",
"description": "ISO 2 letter country codes.",
"valueSetUri": "http://www.iso.org/iso/country_codes.htm"
}
},
{
"path": "Patient.contact",
"min": 0,
"max": "*",
"mustSupport": true
},
{
"path": "Patient.contact.relationship",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.contact.relationship.coding",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.contact.relationship.coding.code",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.contact.name",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.contact.name.family",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.contact.name.given",
"min": 0,
"max": "2",
"mustSupport": true
},
{
"path": "Patient.contact.name.suffix",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.contact.telecom",
"min": 0,
"max": "3",
"mustSupport": true
},
{
"path": "Patient.contact.telecom.system",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.contact.telecom.value",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.contact.address",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.contact.address.extension",
"name": "CountyCountact",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
},
"short": "County/Parish FIPS codes",
"definition": "County/Parish FIPS codes.",
"requirements": "County/Parish Code SHALL use FIPS 6-4 ( INCITS 31:2009).",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": [
"http://hl7.org/fhir/StructureDefinition/us-core-county"
]
}
],
"mustSupport": true,
"binding": {
"strength": "required",
"description": "FIPS codes for US counties and county equivalent entities.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/fips-county"
}
}
},
{
"path": "Patient.contact.address.use",
"min": 1,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.contact.address.line",
"min": 0,
"max": "2",
"mustSupport": true
},
{
"path": "Patient.contact.address.city",
"min": 0,
"max": "1",
"mustSupport": true
},
{
"path": "Patient.contact.address.state",
"requirements": "State SHALL be the two letter USPS alphabetic codes.",
"min": 0,
"max": "1",
"mustSupport": true,
"binding": {
"strength": "required",
"description": "Two letter USPS alphabetic codes.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/usps-state"
}
}
},
{
"path": "Patient.contact.address.postalCode",
"short": "US Zip Codes",
"definition": "US Zip Codes.",
"requirements": "Zip or Postal Code SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes.",
"min": 0,
"max": "1",
"condition": [
"inv-2"
],
"constraint": [
{
"key": "inv-2",
"severity": "error",
"human": "(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.",
"xpath": "f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )"
}
],
"mustSupport": true
},
{
"path": "Patient.contact.address.country",
"short": "ISO 3166 3 letter Country Code",
"definition": "ISO 3166 3 letter Country Code.",
"requirements": "Country SHALL be ISO 3166 3 letter codes.",
"min": 0,
"max": "1",
"mustSupport": true,
"binding": {
"strength": "required",
"description": "ISO 2 letter country codes.",
"valueSetUri": "http://www.iso.org/iso/country_codes.htm"
}
}
]
}
}
© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:44+1100.
Links: Search |
Version History |
Table of Contents |
Compare to DSTU1 |
|
Propose a change