DSTU2 Ballot Source
This page is part of the FHIR Specification (v0.5.0: DSTU 2 Ballot 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 Defines constraints and extensions on the patient resource for use in querying and retrieving patient demographic information.
{
"resourceType": "StructureDefinition",
"id": "patient-daf-dafpatient",
"text": {
"status": "generated",
"div": "<div>!-- Snipped for Brevity --></div>"
},
"url": "http://hl7.org/fhir/StructureDefinition/patient-daf-dafpatient",
"name": "U.S. Data Access Framework (DAF) Patient Profile",
"publisher": "U.S. Office of the National Coordinator (ONC)",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "http://www.healthit.gov"
}
]
}
],
"description": "Defines constraints and extensions on the patient resource for use in querying and retrieving patient demographic information.",
"status": "draft",
"date": "2014-08-21",
"type": "constraint",
"abstract": false,
"base": "http://hl7.org/fhir/StructureDefinition/Patient",
"snapshot": {
"element": [
{
"path": "Patient",
"name": "DAFPatient",
"short": "Information about an individual or animal receiving health care services",
"definition": "Demographics and other administrative information about an individual or animal receiving care or other health-related services.",
"requirements": "Tracking patient is the center of the healthcare process.",
"alias": [
"SubjectOfCare Client Resident"
],
"min": 1,
"max": "1",
"type": [
{
"code": "Patient"
}
],
"mapping": [
{
"identity": "rim",
"map": "Patient[classCode=PAT]"
}
]
},
{
"path": "Patient.id",
"short": "Logical id of this artefact",
"definition": "The logical id of the resource, as used in the url for the resoure. 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",
"type": [
{
"code": "id"
}
]
},
{
"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",
"type": [
{
"code": "Meta"
}
]
},
{
"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",
"type": [
{
"code": "uri"
}
],
"isModifier": 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\n\nNot 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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "Language",
"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",
"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": "*",
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Patient.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
]
},
{
"path": "Patient.extension",
"name": "race",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/us-core-race"
}
],
"mustSupport": true,
"binding": {
"name": "DAFRace",
"strength": "required",
"description": "Race of the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/daf-race"
}
}
},
{
"path": "Patient.extension",
"name": "ethnicity",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/us-core-ethnicity"
}
],
"mustSupport": true,
"binding": {
"name": "DAFEthnicity",
"strength": "required",
"description": "Ethnicity of the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/daf-ethnicity"
}
}
},
{
"path": "Patient.extension",
"name": "religion",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/us-core-religion"
}
],
"mustSupport": true,
"binding": {
"name": "DAFReligion",
"strength": "extensible",
"description": "Religious affiliation of the patient.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ReligiousAffiliation"
}
}
},
{
"path": "Patient.extension",
"name": "mothersMaidenName",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName"
}
],
"mustSupport": true
},
{
"path": "Patient.extension",
"name": "birthPlace",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/birthPlace"
}
],
"mustSupport": true
},
{
"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": "*",
"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": "*",
"type": [
{
"code": "Identifier"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-3"
},
{
"identity": "rim",
"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",
"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": "*",
"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": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "IdentifierUse",
"strength": "required",
"description": "Identifies the purpose for this identifier, if known",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/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": "Description of identifier.",
"comments": "Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"name": "IdentifierType",
"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/vs/identifier-type"
}
},
"mapping": [
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"path": "Patient.identifier.system",
"short": "The namespace for the identifier",
"definition": "Establishes the namespace in which set of possible id values is unique.",
"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",
"type": [
{
"code": "uri"
}
],
"exampleUri": "http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri",
"mustSupport": 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": "The value that is unique within the system.",
"definition": "The value that is unique within the system.",
"comments": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"exampleString": "123456",
"mustSupport": 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",
"type": [
{
"code": "Period"
}
],
"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",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"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.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": 0,
"max": "*",
"type": [
{
"code": "HumanName"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-5, PID-9"
},
{
"identity": "rim",
"map": "name"
}
]
},
{
"path": "Patient.telecom",
"short": "A contact detail for the individual",
"definition": "A contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.",
"comments": "A Patient may have multiple ways to be contacted with different uses or applicable periods. \rMay 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": "*",
"type": [
{
"code": "ContactPoint"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"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",
"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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.telecom.system",
"short": "phone | fax | email | url",
"definition": "Telecommunications form for contact point - what communications system is required to make use of the contact.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"condition": [
"cpt-2"
],
"mustSupport": true,
"binding": {
"name": "ContactPointSystem",
"strength": "required",
"description": "Telecommunications form for contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/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 out of band data such as extensions, 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",
"type": [
{
"code": "string"
}
],
"mustSupport": 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",
"type": [
{
"code": "code"
}
],
"mustSupport": true,
"isModifier": true,
"binding": {
"name": "ContactPointUse",
"strength": "required",
"description": "Use of contact point",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/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.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",
"type": [
{
"code": "Period"
}
],
"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. \nSystems 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": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"mustSupport": true,
"isSummary": true,
"binding": {
"name": "AdminstrativeGender",
"strength": "required",
"description": "The gender of a patient used for adminstrative purposes (as opposed to clinical gender)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"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.",
"requirements": "Age of the individual drives many clinical processes.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"identity": "loinc",
"map": "21112-8"
},
{
"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",
"type": [
{
"code": "boolean"
},
{
"code": "dateTime"
}
],
"mustSupport": true,
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "PID-30\r (bool) and PID-29 (datetime)"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd,\rplayer[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": "*",
"type": [
{
"code": "Address"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"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",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.address.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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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",
"type": [
{
"code": "code"
}
],
"exampleCode": "home",
"isModifier": true,
"binding": {
"name": "AddressUse",
"strength": "required",
"description": "The use of an address",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/address-use"
}
},
"mapping": [
{
"identity": "v2",
"map": "XAD.7"
},
{
"identity": "rim",
"map": "unique(./use)"
},
{
"identity": "servd",
"map": "./AddressPurpose"
}
]
},
{
"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",
"type": [
{
"code": "string"
}
],
"exampleString": "137 Nowhere Street, Erewhon 9132",
"mapping": [
{
"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, \nP.O. Box number, delivery hints, and similar address information.",
"requirements": "home | work | temp | old - purpose of this address.",
"min": 1,
"max": "*",
"type": [
{
"code": "string"
}
],
"exampleString": "137 Nowhere Street",
"mustSupport": true,
"mapping": [
{
"identity": "vcard",
"map": "street address"
},
{
"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": [
"Muncipality"
],
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"exampleString": "Erewhon",
"mustSupport": 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.state",
"short": "Sub-unit of country (abreviations 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).",
"alias": [
"Province",
"Territory"
],
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"binding": {
"name": "DAFUSPSState",
"strength": "required",
"description": "2 letter state list",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/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": "Postal code for area",
"definition": "A postal code designating a region defined by the postal service.",
"alias": [
"Zip"
],
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"exampleString": "9132",
"constraint": [
{
"key": "inv-1",
"name": "Regex for Zip",
"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,
"mapping": [
{
"identity": "vcard",
"map": "postal code"
},
{
"identity": "v2",
"map": "XAD.5"
},
{
"identity": "rim",
"map": "AD.part[parttype = ZIP]"
},
{
"identity": "servd",
"map": "./PostalIdentificationCode"
}
]
},
{
"path": "Patient.address.country",
"short": "Country (can be ISO 3166 3 letter code)",
"definition": "Country - a nation as commonly understood or generally accepted.",
"comments": "ISO 3166 3 letter codes can be used in place of a full country name.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "vcard",
"map": "country name"
},
{
"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",
"type": [
{
"code": "Period"
}
],
"examplePeriod": {
"start": "2010-03-23",
"end": "2010-07-01"
},
"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",
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"name": "DAFMaritalStatus",
"strength": "required",
"description": "Marital status of the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/MaritalStatus"
}
},
"mapping": [
{
"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",
"type": [
{
"code": "boolean"
},
{
"code": "integer"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "v2",
"map": "PID-24 (bool), PID-25 (integer)"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, \rplayer[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": "*",
"type": [
{
"code": "Attachment"
}
],
"mapping": [
{
"identity": "v2",
"map": "OBX-5 - needs a profile"
},
{
"identity": "rim",
"map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc"
}
]
},
{
"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": "*",
"type": [
{
"code": "Element"
}
],
"constraint": [
{
"key": "pat-1",
"name": "ContactNeedsDetails",
"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": "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",
"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": "*",
"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": "*",
"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": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"name": "ContactRelationships",
"strength": "extensible",
"description": "Type of relationship",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/patient-contact-relationship"
}
},
"mapping": [
{
"identity": "v2",
"map": "NK1-7, NK1-3"
},
{
"identity": "rim",
"map": "code"
}
]
},
{
"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",
"type": [
{
"code": "HumanName"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "v2",
"map": "NK1-2"
},
{
"identity": "rim",
"map": "name"
}
]
},
{
"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. \rMay 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": "*",
"type": [
{
"code": "ContactPoint"
}
],
"mustSupport": true,
"mapping": [
{
"identity": "v2",
"map": "NK1-5, NK1-6, NK1-40"
},
{
"identity": "rim",
"map": "telecom"
}
]
},
{
"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",
"type": [
{
"code": "Address"
}
],
"mustSupport": true,
"mapping": [
{
"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",
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Patient.contact.address.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": "*",
"type": [
{
"code": "Extension"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"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": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"exampleCode": "home",
"mustSupport": true,
"isModifier": true,
"binding": {
"name": "AddressUse",
"strength": "required",
"description": "The use of an address",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/address-use"
}
},
"mapping": [
{
"identity": "v2",
"map": "XAD.7"
},
{
"identity": "rim",
"map": "unique(./use)"
},
{
"identity": "servd",
"map": "./AddressPurpose"
}
]
},
{
"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",
"type": [
{
"code": "string"
}
],
"exampleString": "137 Nowhere Street, Erewhon 9132",
"mapping": [
{
"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, \nP.O. Box number, delivery hints, and similar address information.",
"requirements": "home | work | temp | old - purpose of this address.",
"min": 0,
"max": "2",
"type": [
{
"code": "string"
}
],
"exampleString": "137 Nowhere Street",
"mustSupport": true,
"mapping": [
{
"identity": "vcard",
"map": "street address"
},
{
"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": [
"Muncipality"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"exampleString": "Erewhon",
"mustSupport": 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.state",
"short": "Sub-unit of country (abreviations 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).",
"alias": [
"Province",
"Territory"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"binding": {
"name": "DAFUSPSState",
"strength": "required",
"description": "2 letter state list",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/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": "Postal code for area",
"definition": "A postal code designating a region defined by the postal service.",
"alias": [
"Zip"
],
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"exampleString": "9132",
"constraint": [
{
"key": "inv-2",
"name": "Regex for Zip",
"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,
"mapping": [
{
"identity": "vcard",
"map": "postal 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.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"binding": {
"name": "USCountry",
"strength": "extensible",
"description": "ISO 2 letter Country Codes",
"valueSetUri": "http://www.iso.org/iso/country_codes.htm"
},
"mapping": [
{
"identity": "vcard",
"map": "country name"
},
{
"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",
"type": [
{
"code": "Period"
}
],
"examplePeriod": {
"start": "2010-03-23",
"end": "2010-07-01"
},
"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",
"type": [
{
"code": "code"
}
],
"binding": {
"name": "AdministrativeGender",
"strength": "required",
"description": "The gender of a person used for administrative purposes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
},
"mapping": [
{
"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",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"condition": [
"pat-1"
],
"mapping": [
{
"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",
"type": [
{
"code": "Period"
}
]
},
{
"path": "Patient.animal",
"short": "If this patient is an animal (non-human)",
"definition": "This element has a value if the patient is 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 non-human patient records.",
"requirements": "Many clinical systems are extended to care for animal patients as well as human.",
"min": 0,
"max": "0",
"type": [
{
"code": "=Animal"
}
],
"isModifier": true,
"isSummary": true,
"mapping": [
{
"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",
"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": "*",
"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": "*",
"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 code for \"Hereford Cattle Breed\" does.).",
"requirements": "Need to know what kind of animal.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "AnimalSpecies",
"strength": "example",
"description": "The species of an animal",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/animal-species"
}
},
"mapping": [
{
"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",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "AnimalBreed",
"strength": "example",
"description": "The breed of an animal",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/animal-breeds"
}
},
"mapping": [
{
"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",
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"name": "AnimalGenderStatus",
"strength": "example",
"description": "The state of the animal's reproductive organs",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/animal-genderstatus"
}
},
"mapping": [
{
"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.\rIf you need to convey proficiency for multiple modes than you need multiple Patient.Communication associations. \r\rFor 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": "*",
"mustSupport": true,
"mapping": [
{
"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",
"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": "*",
"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": "*",
"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",
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"name": "Language",
"strength": "required",
"description": "A human language",
"valueSetUri": "http://tools.ietf.org/html/bcp47"
},
"mapping": [
{
"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",
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "v2",
"map": "PID-15"
},
{
"identity": "rim",
"map": "preferenceInd"
}
]
},
{
"path": "Patient.careProvider",
"short": "Patient's nominated care provider",
"definition": "Patient's nominated care provider.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/org-daf-daforganization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/pract-daf-dafpract"
}
],
"mustSupport": true,
"mapping": [
{
"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.",
"requirements": "Need to know who recognizes this patient record, manages and updates it.",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/org-daf-daforganization"
}
],
"mustSupport": true,
"isSummary": true,
"mapping": [
{
"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: * 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": "*",
"isModifier": true,
"mapping": [
{
"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",
"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": "*",
"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": "*",
"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",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/Patient"
}
],
"isModifier": true,
"mapping": [
{
"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",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"binding": {
"name": "LinkType",
"strength": "required",
"description": "The type of link between this patient resource and another patient resource.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/link-type"
}
},
"mapping": [
{
"identity": "rim",
"map": "typeCode"
}
]
},
{
"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",
"type": [
{
"code": "boolean"
}
],
"defaultValueBoolean": true,
"mustSupport": true,
"isModifier": true,
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "statusCode"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Patient",
"name": "DAFPatient",
"min": 1,
"max": "1",
"type": [
{
"code": "Patient"
}
]
},
{
"path": "Patient.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
}
},
{
"path": "Patient.extension",
"name": "race",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/us-core-race"
}
],
"mustSupport": true,
"binding": {
"name": "DAFRace",
"strength": "required",
"description": "Race of the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/daf-race"
}
}
},
{
"path": "Patient.extension",
"name": "ethnicity",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/us-core-ethnicity"
}
],
"mustSupport": true,
"binding": {
"name": "DAFEthnicity",
"strength": "required",
"description": "Ethnicity of the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/daf-ethnicity"
}
}
},
{
"path": "Patient.extension",
"name": "religion",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/us-core-religion"
}
],
"mustSupport": true,
"binding": {
"name": "DAFReligion",
"strength": "extensible",
"description": "Religious affiliation of the patient.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/ReligiousAffiliation"
}
}
},
{
"path": "Patient.extension",
"name": "mothersMaidenName",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/patient-mothersMaidenName"
}
],
"mustSupport": true
},
{
"path": "Patient.extension",
"name": "birthPlace",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/birthPlace"
}
],
"mustSupport": true
},
{
"path": "Patient.identifier",
"min": 1,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"mustSupport": true
},
{
"path": "Patient.identifier.type",
"short": "Description of identifier",
"definition": "Description of identifier.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true
},
{
"path": "Patient.identifier.system",
"min": 1,
"max": "1",
"type": [
{
"code": "uri"
}
],
"mustSupport": true
},
{
"path": "Patient.identifier.value",
"short": "The value that is unique within the system.",
"definition": "The value that is unique within the system.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true
},
{
"path": "Patient.name",
"min": 0,
"max": "*",
"type": [
{
"code": "HumanName"
}
],
"mustSupport": true
},
{
"path": "Patient.telecom",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"mustSupport": true
},
{
"path": "Patient.telecom.system",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"mustSupport": true
},
{
"path": "Patient.telecom.value",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true
},
{
"path": "Patient.telecom.use",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"mustSupport": true
},
{
"path": "Patient.gender",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"mustSupport": true,
"binding": {
"name": "AdminstrativeGender",
"strength": "required",
"description": "The gender of a patient used for adminstrative purposes (as opposed to clinical gender)",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/administrative-gender"
}
}
},
{
"path": "Patient.birthDate",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
],
"mustSupport": true
},
{
"path": "Patient.deceased[x]",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "dateTime"
}
],
"mustSupport": true
},
{
"path": "Patient.address",
"min": 0,
"max": "*",
"type": [
{
"code": "Address"
}
],
"mustSupport": true
},
{
"path": "Patient.address.line",
"min": 1,
"max": "*",
"type": [
{
"code": "string"
}
],
"mustSupport": true
},
{
"path": "Patient.address.city",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true
},
{
"path": "Patient.address.state",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true,
"binding": {
"name": "DAFUSPSState",
"strength": "required",
"description": "2 letter state list",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/usps-state"
}
}
},
{
"path": "Patient.address.postalCode",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"condition": [
"inv-1"
],
"constraint": [
{
"key": "inv-1",
"name": "Regex for Zip",
"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",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
],
"mustSupport": true
},
{
"path": "Patient.maritalStatus",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"name": "DAFMaritalStatus",
"strength": "required",
"description": "Marital status of the patient",
"valueSetReference": {
"reference": "http://hl7.org/fhir/v3/vs/MaritalStatus"
}
}
},
{
"path": "Patient.multipleBirth[x]",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
},
{
"code": "integer"
}
],
"mustSupport": true
},
{
"path": "Patient.contact",
"min": 0,
"max": "*",
"type": [
{
"code": "Element"
}
],
"mustSupport": true
},
{
"path": "Patient.contact.relationship",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true,
"binding": {
"name": "ContactRelationships",
"strength": "extensible",
"description": "Type of relationship",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/patient-contact-relationship"
}
}
},
{
"path": "Patient.contact.name",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
],
"mustSupport": true
},
{
"path": "Patient.contact.telecom",
"min": 0,
"max": "*",
"type": [
{
"code": "ContactPoint"
}
],
"mustSupport": true
},
{
"path": "Patient.contact.address",
"min": 0,
"max": "1",
"type": [
{
"code": "Address"
}
],
"mustSupport": true
},
{
"path": "Patient.contact.address.use",
"min": 0,
"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",
"min": 0,
"max": "1",
"mustSupport": true,
"binding": {
"name": "DAFUSPSState",
"strength": "required",
"description": "2 letter state list",
"valueSetReference": {
"reference": "http://hl7.org/fhir/vs/usps-state"
}
}
},
{
"path": "Patient.contact.address.postalCode",
"min": 0,
"max": "1",
"condition": [
"inv-2"
],
"constraint": [
{
"key": "inv-2",
"name": "Regex for Zip",
"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.",
"min": 0,
"max": "1",
"mustSupport": true,
"binding": {
"name": "USCountry",
"strength": "extensible",
"description": "ISO 2 letter Country Codes",
"valueSetUri": "http://www.iso.org/iso/country_codes.htm"
}
},
{
"path": "Patient.animal",
"min": 0,
"max": "0",
"type": [
{
"code": "=Animal"
}
]
},
{
"path": "Patient.communication",
"min": 0,
"max": "*",
"mustSupport": true
},
{
"path": "Patient.communication.language",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"mustSupport": true
},
{
"path": "Patient.careProvider",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/org-daf-daforganization"
},
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/pract-daf-dafpract"
}
],
"mustSupport": true
},
{
"path": "Patient.managingOrganization",
"min": 0,
"max": "1",
"type": [
{
"code": "Reference",
"profile": "http://hl7.org/fhir/StructureDefinition/org-daf-daforganization"
}
],
"mustSupport": true
},
{
"path": "Patient.active",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
],
"mustSupport": true
}
]
}
}
© HL7.org 2011+. FHIR DSTU (v0.5.0-5149) generated on Fri, Apr 3, 2015 14:35+1100.
Links: What's a DSTU? |
Version History |
Specification Map |
Compare to DSTU1 |
|
Propose a change