{ "resourceType": "StructureDefinition", "id": "spark1707", "meta": { "versionId": "spark2112", "lastUpdated": "2015-12-18T18:18:09.898+00:00" }, "url": "http://premierinc.com/fhir/StructureDefinition/tdaf-patient", "name": "TheraDoc Data Access Framework (TDAF) Patient Profile", "display": "TDAF-Patient", "status": "draft", "publisher": "NA", "contact": [ { "telecom": [ { "system": "other", "value": "http://www.healthit.gov" } ] } ], "date": "2014-08-21", "description": "Defines constraints and extensions on the patient resource for use in querying and retrieving patient demographic information.", "fhirVersion": "1.0.1", "kind": "resource", "constrainedType": "Patient", "abstract": false, "base": "http://hl7.org/fhir/StructureDefinition/Patient", "differential": { "element": [ { "path": "Patient", "name": "TDAF-Patient", "short": "Information about an individual or animal receiving health care services", "definition": "Demographics and other administrative information about an individual or animal receiving care or other health-related services.", "alias": [ "SubjectOfCare Client Resident" ], "min": 0, "max": "*", "type": [ { "code": "Patient" } ], "mapping": [ { "identity": "rim", "map": "Patient[classCode=PAT]" }, { "identity": "cda", "map": "ClinicalDocument.recordTarget.patientRole" }, { "identity": "w5", "map": "administrative.individual" } ] }, { "path": "Patient.extension", "slicing": { "discriminator": [ "url" ], "rules": "openAtEnd" } }, { "path": "Patient.extension", "name": "race", "label": "race", "short": "race", "definition": "http://hl7.org/fhir/StructureDefinition/us-core-race", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/us-core-race" ] } ], "mustSupport": true }, { "path": "Patient.extension", "name": "Age", "label": "Age", "short": "Age of the Patient", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/Age" ] } ], "mustSupport": true }, { "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" }, { "identity": "cda", "map": ".id" }, { "identity": "w5", "map": "id" } ] }, { "path": "Patient.identifier.type", "short": "Description of identifier", "definition": "Description of identifier.", "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. 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, "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": "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 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": "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, "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.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" }, { "identity": "cda", "map": "n/a" }, { "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": 0, "max": "*", "type": [ { "code": "HumanName" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-5, PID-9" }, { "identity": "rim", "map": "name" }, { "identity": "cda", "map": ".patient.name" } ] }, { "path": "Patient.name.extension", "slicing": { "discriminator": [ "url" ], "rules": "openAtEnd" } }, { "path": "Patient.name.extension", "name": "middle", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://simplifier.net/fhir/KYtest/StructureDefinition/spark1705" ] } ], "mustSupport": true }, { "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", "type": [ { "code": "string" } ], "mustSupport": true, "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": 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": "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": "*", "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.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": "*", "type": [ { "code": "string" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN/4" }, { "identity": "rim", "map": "./part[partType = SFX]" } ] }, { "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. 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": "0", "type": [ { "code": "ContactPoint" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-13, PID-14, PID-40" }, { "identity": "rim", "map": "telecom" }, { "identity": "cda", "map": ".telecom" } ] }, { "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", "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", "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": 0, "max": "1", "type": [ { "code": "code" } ], "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.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": 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": "v2", "map": "PID-8" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender" }, { "identity": "cda", "map": ".patient.administrativeGenderCode" } ] }, { "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", "type": [ { "code": "date" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-7" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime" }, { "identity": "cda", "map": ".patient.birthTime" }, { "identity": "loinc", "map": "21112-8" } ] }, { "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 (bool) and PID-29 (datetime)" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime" }, { "identity": "cda", "map": "n/a" } ] }, { "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": "0", "type": [ { "code": "Address" } ], "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-11" }, { "identity": "rim", "map": "addr" }, { "identity": "cda", "map": ".addr" } ] }, { "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": 1, "max": "*", "type": [ { "code": "string" } ], "exampleString": "137 Nowhere Street", "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "vcard", "map": "street" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ] }, { "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": 1, "max": "1", "type": [ { "code": "string" } ], "exampleString": "Erewhon", "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.3" }, { "identity": "rim", "map": "AD.part[parttype = CTY]" }, { "identity": "vcard", "map": "locality" }, { "identity": "servd", "map": "./Jurisdiction" } ] }, { "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).", "alias": [ "Province", "Territory" ], "min": 1, "max": "1", "type": [ { "code": "string" } ], "mustSupport": true, "isSummary": true, "binding": { "strength": "required", "description": "2 letter state list", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/usps-state" } }, "mapping": [ { "identity": "v2", "map": "XAD.4" }, { "identity": "rim", "map": "AD.part[parttype = STA]" }, { "identity": "vcard", "map": "region" }, { "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", "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, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.5" }, { "identity": "rim", "map": "AD.part[parttype = ZIP]" }, { "identity": "vcard", "map": "code" }, { "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, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.6" }, { "identity": "rim", "map": "AD.part[parttype = CNT]" }, { "identity": "vcard", "map": "country" }, { "identity": "servd", "map": "./Country" } ] }, { "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": { "strength": "required", "description": "The domestic partnership status of a person.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/marital-status" } }, "mapping": [ { "identity": "v2", "map": "PID-16" }, { "identity": "rim", "map": "player[classCode=PSN]/maritalStatusCode" }, { "identity": "cda", "map": ".patient.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": "0", "type": [ { "code": "boolean" }, { "code": "integer" } ], "mapping": [ { "identity": "v2", "map": "PID-24 (bool), PID-25 (integer)" }, { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber" }, { "identity": "cda", "map": "n/a" } ] }, { "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": "0", "type": [ { "code": "BackboneElement" } ], "mapping": [ { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]" }, { "identity": "cda", "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": { "strength": "required", "description": "Type of relationship", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/patient-contact-relationship" } }, "mapping": [ { "identity": "v2", "map": "NK1-7, NK1-3" }, { "identity": "rim", "map": "code" }, { "identity": "cda", "map": "n/a" } ] }, { "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" }, { "identity": "cda", "map": "n/a" } ] }, { "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": "*", "type": [ { "code": "ContactPoint" } ], "mustSupport": true, "mapping": [ { "identity": "v2", "map": "NK1-5, NK1-6, NK1-40" }, { "identity": "rim", "map": "telecom" }, { "identity": "cda", "map": "n/a" } ] }, { "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" }, { "identity": "cda", "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, "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.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": "*", "type": [ { "code": "string" } ], "exampleString": "137 Nowhere Street", "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)" }, { "identity": "rim", "map": "AD.part[parttype = AL]" }, { "identity": "vcard", "map": "street" }, { "identity": "servd", "map": "./StreetAddress (newline delimitted)" } ] }, { "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", "type": [ { "code": "string" } ], "exampleString": "Erewhon", "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.3" }, { "identity": "rim", "map": "AD.part[parttype = CTY]" }, { "identity": "vcard", "map": "locality" }, { "identity": "servd", "map": "./Jurisdiction" } ] }, { "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).", "alias": [ "Province", "Territory" ], "min": 0, "max": "1", "type": [ { "code": "string" } ], "mustSupport": true, "isSummary": true, "binding": { "strength": "required", "description": "2 letter state list", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/usps-state" } }, "mapping": [ { "identity": "v2", "map": "XAD.4" }, { "identity": "rim", "map": "AD.part[parttype = STA]" }, { "identity": "vcard", "map": "region" }, { "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", "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, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XAD.5" }, { "identity": "rim", "map": "AD.part[parttype = ZIP]" }, { "identity": "vcard", "map": "code" }, { "identity": "servd", "map": "./PostalIdentificationCode" } ] }, { "path": "Patient.contact.address.country", "short": "ISO 3166 2 or 3 letter Country Code", "definition": "ISO 3166 2 or 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, "isSummary": true, "binding": { "strength": "required", "description": "ISO 2 letter country codes.", "valueSetUri": "http://www.iso.org/iso/country_codes.htm" }, "mapping": [ { "identity": "v2", "map": "XAD.6" }, { "identity": "rim", "map": "AD.part[parttype = CNT]" }, { "identity": "vcard", "map": "country" }, { "identity": "servd", "map": "./Country" } ] }, { "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": "0", "type": [ { "code": "BackboneElement" } ], "isModifier": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "player[classCode=ANM]" }, { "identity": "cda", "map": "n/a" } ] }, { "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": "0", "type": [ { "code": "BackboneElement" } ], "mapping": [ { "identity": "rim", "map": "LanguageCommunication" }, { "identity": "cda", "map": "patient.languageCommunication" } ] }, { "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": { "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" }, { "identity": "cda", "map": ".languageCode" } ] }, { "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. This is not to be used to record Care Teams, these should be recorded on either the CarePlan or EpisodeOfCare resources.", "min": 0, "max": "0", "type": [ { "code": "Reference", "profile": [ "http://premierinc.com/fhir/StructureDefinition/tdaf-organization" ] }, { "code": "Reference", "profile": [ "http://premierinc.com/fhir/StructureDefinition/tdaf-pract" ] } ], "mustSupport": true, "mapping": [ { "identity": "v2", "map": "PD1-4" }, { "identity": "rim", "map": "subjectOf.CareEvent.performer.AssignedEntity" }, { "identity": "cda", "map": "n/a" } ] }, { "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", "type": [ { "code": "Reference", "profile": [ "http://premierinc.com/fhir/StructureDefinition/tdaf-organization" ] } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": "scoper" }, { "identity": "cda", "map": ".providerOrganization" } ] } ] } }