US Core Patient Profile (USCorePatient) | C | | http://hl7.org/fhir/StructureDefinition/Patient | There are no (further) constraints on this element Element idPatient:uscorepatient Short descriptionUS Core Patient Profile Alternate namesSubjectOfCare Client Resident DefinitionThe US Core Patient Profile is based upon the core FHIR Patient Resource and designed to meet the applicable patient demographic data elements from the 2015 Edition Common Clinical Data Set.
Data typehttp://hl7.org/fhir/StructureDefinition/Patient Constraints- dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty() - dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative
contained.text.empty() - dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() - dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
contained.where(('#'+id in %resource.descendants().reference).not()).empty() Mappings- rim: Entity. Role, or Act
- rim: Patient[classCode=PAT]
- cda: ClinicalDocument.recordTarget.patientRole
- w5: administrative.individual
- argonaut-dq-dstu2: Patient
|
id | Σ | 0..1 | id | There are no (further) constraints on this element Element idPatient:uscorepatient.id Short descriptionLogical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
CommentsThe only time that a resource does not have an id is when it is being submitted to the server using a create operation.
Data typeid |
meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idPatient:uscorepatient.meta Short descriptionMetadata about the resource DefinitionThe 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.
Data typeMeta |
implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idPatient:uscorepatient.implicitRules Short descriptionA set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.
CommentsAsserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.
This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.
Data typeuri |
language | | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient:uscorepatient.language Short descriptionLanguage of the resource content DefinitionThe base language in which the resource is written.
CommentsLanguage is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Data typecode BindingA human language. http://hl7.org/fhir/ValueSet/languages (extensible) Binding extensions |
text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idPatient:uscorepatient.text Short descriptionText summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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.
CommentsContained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.
Data typeNarrative ConditionsThe cardinality or value of this element may be affected by these constraints: dom-1 Mappings |
contained | | 0..* | Resource | There are no (further) constraints on this element Element idPatient:uscorepatient.contained Short descriptionContained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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.
CommentsThis 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.
Data typeResource Mappings |
extension | | 0..* | Extension | There are no (further) constraints on this element Element idPatient:uscorepatient.extension Short descriptionExtension DefinitionData typeExtension SlicingUnordered, Open, by url(Value) |
race | S | 0..1 | Extension | There are no (further) constraints on this element Element idPatient:uscorepatient.extension:race Short descriptionExtension DefinitionData typeExtension Extension URLhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-race Mappings- argonaut-dq-dstu2: Patient.extension
|
ethnicity | S | 0..1 | Extension | There are no (further) constraints on this element Element idPatient:uscorepatient.extension:ethnicity Short descriptionExtension DefinitionData typeExtension Extension URLhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-ethnicity Mappings- argonaut-dq-dstu2: Patient.extension
|
birthsex | S | 0..1 | Extension | There are no (further) constraints on this element Element idPatient:uscorepatient.extension:birthsex Short descriptionExtension DefinitionData typeExtension Extension URLhttp://hl7.org/fhir/us/core/StructureDefinition/us-core-birthsex Mappings- argonaut-dq-dstu2: Patient.extension
|
modifierExtension | ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient:uscorepatient.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension Mappings |
identifier | S Σ | 1..* | Identifier | There are no (further) constraints on this element Element idPatient:uscorepatient.identifier Short descriptionAn identifier for this patient DefinitionAn identifier for this patient.
RequirementsPatients are almost always assigned specific numerical identifiers.
Data typeIdentifier Mappings- v2: PID-3
- rim: id
- cda: .id
- w5: id
- argonaut-dq-dstu2: Patient.identifier
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient:uscorepatient.identifier.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | | 0..* | Extension | There are no (further) constraints on this element Element idPatient:uscorepatient.identifier.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings |
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient:uscorepatient.identifier.use Short descriptionusual | official | temp | secondary (If known) DefinitionThe purpose of this identifier.
RequirementsAllows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
CommentsThis 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.
Data typecode BindingIdentifies the purpose for this identifier, if known . http://hl7.org/fhir/ValueSet/identifier-use (required) Mappings- v2: N/A
- rim: Role.code or implied by context
|
type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient:uscorepatient.identifier.type Short descriptionDescription of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
RequirementsAllows users to make use of identifiers when the identifier system is not known.
CommentsThis 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.
Data typeCodeableConcept BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose. http://hl7.org/fhir/ValueSet/identifier-type (extensible) Mappings- v2: CX.5
- rim: Role.code or implied by context
|
system | S Σ | 1..1 | uri | There are no (further) constraints on this element Element idPatient:uscorepatient.identifier.system Short descriptionThe namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
RequirementsThere are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
Data typeuri Examples Generalhttp://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri Mappings- v2: CX.4 / EI-2-4
- rim: II.root or Role.id.root
- servd: ./IdentifierType
- argonaut-dq-dstu2: Patient.identifier.system
|
value | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient:uscorepatient.identifier.value Short descriptionThe value that is unique within the system. DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system.
CommentsIf the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.
Data typestring Examples General123456 Mappings- v2: CX.1 / EI.1
- rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
- servd: ./Value
- argonaut-dq-dstu2: Patient.identifier.value
|
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient:uscorepatient.identifier.period Short descriptionTime period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
Data typePeriod Mappings- v2: CX.7 + CX.8
- rim: Role.effectiveTime or implied by context
- servd: ./StartDate and ./EndDate
|
assigner | Σ | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Organization) | There are no (further) constraints on this element Element idPatient:uscorepatient.identifier.assigner Short descriptionOrganization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier.
CommentsThe Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
Data typeReference(http://hl7.org/fhir/StructureDefinition/Organization) Mappings- v2: CX.4 / (CX.4,CX.9,CX.10)
- rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
- servd: ./IdentifierIssuingAuthority
|
active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idPatient:uscorepatient.active Short descriptionWhether this patient's record is in active use DefinitionWhether this patient record is in active use.
RequirementsNeed to be able to mark a patient record as not to be used because it was created in error.
CommentsDefault is true. If a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient
This element is labeled as a modifier because when the patient record is marked as not active it is not expected to be used/referenced without being changed back to active.
Data typeboolean Default valuetrue Mappings- rim: statusCode
- cda: n/a
- w5: status
|
name | S Σ | 1..* | HumanName | There are no (further) constraints on this element Element idPatient:uscorepatient.name Short descriptionA name associated with the patient DefinitionA name associated with the individual.
RequirementsNeed to be able to track the patient by multiple names. Examples are your official name and a partner name.
CommentsA 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.
Data typeHumanName Mappings- v2: PID-5, PID-9
- rim: name
- cda: .patient.name
- argonaut-dq-dstu2: Patient.name
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient:uscorepatient.name.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | | 0..* | Extension | There are no (further) constraints on this element Element idPatient:uscorepatient.name.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension SlicingUnordered, Open, by url(Value) Extensions are always sliced by (at least) url Mappings |
use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient:uscorepatient.name.use Short descriptionusual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name.
RequirementsAllows the appropriate name for a particular context of use to be selected from among a set of names.
CommentsThis is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old.
Data typecode BindingThe use of a human name http://hl7.org/fhir/ValueSet/name-use (required) Mappings- v2: XPN.7, but often indicated by which field contains the name
- rim: unique(./use)
- servd: ./NamePurpose
|
text | Σ | 0..1 | string | There are no (further) constraints on this element Element idPatient:uscorepatient.name.text Short descriptionText representation of the full name DefinitionA full text representation of the name.
RequirementsA renderable, unencoded form.
CommentsCan provide both a text representation and structured parts.
Data typestring Mappings- v2: implied by XPN.11
- rim: ./formatted
|
family | S Σ | 1..1 | string | There are no (further) constraints on this element Element idPatient:uscorepatient.name.family Short descriptionFamily name (often called 'Surname') Alternate namessurname DefinitionThe 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.
CommentsFamily Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
Data typestring Mappings- v2: XPN.1/FN.1
- rim: ./part[partType = FAM]
- servd: ./FamilyName
- argonaut-dq-dstu2: Patient.name.family
|
given | S Σ | 1..* | string | There are no (further) constraints on this element Element idPatient:uscorepatient.name.given Short descriptionGiven names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionCommentsIf 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.
Data typestring Mappings- v2: XPN.2 + XPN.3
- rim: ./part[partType = GIV]
- servd: ./GivenNames
- argonaut-dq-dstu2: Patient.name.given
|
prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient:uscorepatient.name.prefix Short descriptionParts that come before the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
Data typestring Mappings- v2: XPN.5
- rim: ./part[partType = PFX]
- servd: ./TitleCode
|
suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idPatient:uscorepatient.name.suffix Short descriptionParts that come after the name DefinitionPart 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.
Data typestring Mappings- v2: XPN/4
- rim: ./part[partType = SFX]
|
period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idPatient:uscorepatient.name.period Short descriptionTime period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person.
RequirementsAllows names to be placed in historical context.
Data typePeriod Mappings- v2: XPN.13 + XPN.14
- rim: ./usablePeriod[type="IVL<TS>"]
- servd: ./StartDate and ./EndDate
|
telecom | Σ | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient:uscorepatient.telecom Short descriptionA contact detail for the individual DefinitionA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.
RequirementsPeople have (primary) ways to contact them in some way such as phone, email.
CommentsA 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).
Data typeContactPoint Mappings- v2: PID-13, PID-14, PID-40
- rim: telecom
- cda: .telecom
|
gender | S Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient:uscorepatient.gender Short descriptionmale | female | other | unknown DefinitionAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.
RequirementsNeeded for identification of the individual, in combination with (at least) name and birth date. Gender of individual drives many clinical processes.
CommentsThe 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.
Data typecode Bindinghttp://hl7.org/fhir/ValueSet/administrative-gender (required) Mappings- v2: PID-8
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
- cda: .patient.administrativeGenderCode
- argonaut-dq-dstu2: Patient.gender
|
birthDate | S Σ | 0..1 | date | There are no (further) constraints on this element Element idPatient:uscorepatient.birthDate Short descriptionThe date of birth for the individual DefinitionThe date of birth for the individual.
RequirementsAge of the individual drives many clinical processes.
CommentsAt 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).
Data typedate Mappings- v2: PID-7
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTime
- cda: .patient.birthTime
- loinc: 21112-8
- argonaut-dq-dstu2: Patient.birthDate
|
deceased[x] | Σ ?! | 0..1 | | There are no (further) constraints on this element Element idPatient:uscorepatient.deceased[x] Short descriptionIndicates if the individual is deceased or not DefinitionIndicates if the individual is deceased or not.
RequirementsThe 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.
CommentsIf there's no value in the instance it means there is no statement on whether or not the individual is deceased. Most systems will interpret the absence of a value as a sign of the person being alive.
This element is labeled as a modifier because once a patient is marked as deceased, the actions that are appropriate to perform on the patient may be significantly different.
Mappings- v2: PID-30 (bool) and PID-29 (datetime)
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTime
- cda: n/a
|
deceasedBoolean | | | boolean | There are no (further) constraints on this element Data typeboolean |
deceasedDateTime | | | dateTime | There are no (further) constraints on this element Data typedateTime |
address | Σ | 0..* | Address | There are no (further) constraints on this element Element idPatient:uscorepatient.address Short descriptionAddresses for the individual DefinitionAddresses for the individual.
RequirementsMay need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.
CommentsPatient may have multiple addresses with different uses or applicable periods.
Data typeAddress Mappings- v2: PID-11
- rim: addr
- cda: .addr
|
maritalStatus | | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient:uscorepatient.maritalStatus Short descriptionMarital (civil) status of a patient DefinitionThis field contains a patient's most recent marital (civil) status.
RequirementsMost, if not all systems capture it.
Data typeCodeableConcept BindingThe domestic partnership status of a person. http://hl7.org/fhir/ValueSet/marital-status (extensible) Mappings- v2: PID-16
- rim: player[classCode=PSN]/maritalStatusCode
- cda: .patient.maritalStatusCode
|
multipleBirth[x] | | 0..1 | | There are no (further) constraints on this element Element idPatient:uscorepatient.multipleBirth[x] Short descriptionWhether patient is part of a multiple birth DefinitionIndicates whether the patient is part of a multiple (bool) or indicates the actual birth order (integer).
RequirementsFor disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.
CommentsWhere the valueInteger is provided, the number is the birth number in the sequence.
E.g. The middle birth in tripplets would be valueInteger=2 and the third born would have valueInteger=3
If a bool value was provided for this tripplets examle, then all 3 patient records would have valueBool=true (the ordering is not indicated).
Mappings- v2: PID-24 (bool), PID-25 (integer)
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumber
- cda: n/a
|
multipleBirthBoolean | | | boolean | There are no (further) constraints on this element Data typeboolean |
multipleBirthInteger | | | integer | There are no (further) constraints on this element Data typeinteger |
photo | | 0..* | Attachment | There are no (further) constraints on this element Element idPatient:uscorepatient.photo Short descriptionImage of the patient DefinitionRequirementsMany EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.
Data typeAttachment Mappings- v2: OBX-5 - needs a profile
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/desc
- cda: n/a
|
contact | C | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient:uscorepatient.contact Short descriptionA contact party (e.g. guardian, partner, friend) for the patient DefinitionA contact party (e.g. guardian, partner, friend) for the patient.
RequirementsNeed to track people you can contact about the patient.
CommentsContact 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.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
children().count() > id.count() - pat-1: SHALL at least contain a contact's details or a reference to an organization
name.exists() or telecom.exists() or address.exists() or organization.exists() Mappings- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]
- cda: n/a
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient:uscorepatient.contact.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | | 0..* | Extension | There are no (further) constraints on this element Element idPatient:uscorepatient.contact.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension Mappings |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient:uscorepatient.contact.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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.
CommentsThere 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.
Data typeExtension Mappings |
relationship | | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient:uscorepatient.contact.relationship Short descriptionThe kind of relationship DefinitionThe nature of the relationship between the patient and the contact person.
RequirementsUsed to determine which contact person is the most relevant to approach, depending on circumstances.
Data typeCodeableConcept BindingThe nature of the relationship between a patient and a contact person for that patient. http://hl7.org/fhir/ValueSet/v2-0131 (extensible) Mappings- v2: NK1-7, NK1-3
- rim: code
- cda: n/a
|
name | | 0..1 | HumanName | There are no (further) constraints on this element Element idPatient:uscorepatient.contact.name Short descriptionA name associated with the contact person DefinitionA name associated with the contact person.
RequirementsContact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.
Data typeHumanName Mappings- v2: NK1-2
- rim: name
- cda: n/a
|
telecom | | 0..* | ContactPoint | There are no (further) constraints on this element Element idPatient:uscorepatient.contact.telecom Short descriptionA contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address.
RequirementsPeople have (primary) ways to contact them in some way such as phone, email.
CommentsContact 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.
Data typeContactPoint Mappings- v2: NK1-5, NK1-6, NK1-40
- rim: telecom
- cda: n/a
|
address | | 0..1 | Address | There are no (further) constraints on this element Element idPatient:uscorepatient.contact.address Short descriptionAddress for the contact person DefinitionAddress for the contact person.
RequirementsNeed to keep track where the contact person can be contacted per postal mail or visited.
Data typeAddress Mappings- v2: NK1-4
- rim: addr
- cda: n/a
|
gender | | 0..1 | codeBinding | There are no (further) constraints on this element Element idPatient:uscorepatient.contact.gender Short descriptionmale | female | other | unknown DefinitionAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.
RequirementsNeeded to address the person correctly.
Data typecode BindingThe gender of a person used for administrative purposes. http://hl7.org/fhir/ValueSet/administrative-gender (required) Mappings- v2: NK1-15
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGender
- cda: n/a
|
organization | C | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Organization) | There are no (further) constraints on this element Element idPatient:uscorepatient.contact.organization Short descriptionOrganization that is associated with the contact DefinitionOrganization on behalf of which the contact is acting or for which the contact is working.
RequirementsFor guardians or business related contacts, the organization is relevant.
Data typeReference(http://hl7.org/fhir/StructureDefinition/Organization) ConditionsThe cardinality or value of this element may be affected by these constraints: pat-1 Mappings- v2: NK1-13, NK1-30, NK1-31, NK1-32, NK1-41
- rim: scoper
- cda: n/a
|
period | | 0..1 | Period | There are no (further) constraints on this element Element idPatient:uscorepatient.contact.period Short descriptionThe period during which this contact person or organization is valid to be contacted relating to this patient DefinitionThe period during which this contact person or organization is valid to be contacted relating to this patient.
Data typePeriod Mappings- rim: effectiveTime
- cda: n/a
|
animal | Σ ?! | 0..0 | BackboneElement | There are no (further) constraints on this element Element idPatient:uscorepatient.animal Short descriptionThis patient is known to be an animal (non-human) DefinitionThis patient is known to be an animal.
RequirementsMany clinical systems are extended to care for animal patients as well as human.
CommentsThe 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).
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
children().count() > id.count() Mappings- rim: player[classCode=ANM]
- cda: n/a
- argonaut-dq-dstu2: Patient.animal
|
communication | S | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient:uscorepatient.communication Short descriptionA list of Languages which may be used to communicate with the patient about his or her health DefinitionLanguages which may be used to communicate with the patient about his or her health.
RequirementsIf 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.
CommentsIf 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.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
children().count() > id.count() Mappings- rim: LanguageCommunication
- cda: patient.languageCommunication
- argonaut-dq-dstu2: Patient.communication
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient:uscorepatient.communication.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | | 0..* | Extension | There are no (further) constraints on this element Element idPatient:uscorepatient.communication.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension Mappings |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient:uscorepatient.communication.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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.
CommentsThere 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.
Data typeExtension Mappings |
language | S | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idPatient:uscorepatient.communication.language Short descriptionThe language which can be used to communicate with the patient about his or her health DefinitionThe 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.
RequirementsMost systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.
CommentsThe 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.
Data typeCodeableConcept Bindinghttp://hl7.org/fhir/us/core/ValueSet/simple-language (extensible) Binding extensionsMappings- v2: PID-15, LAN-2
- rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
- cda: .languageCode
- argonaut-dq-dstu2: Patient.communication.language
|
preferred | | 0..1 | boolean | There are no (further) constraints on this element Element idPatient:uscorepatient.communication.preferred Short descriptionLanguage preference indicator DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level).
RequirementsPeople 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.
CommentsThis language is specifically identified for communicating healthcare information.
Data typeboolean Mappings- v2: PID-15
- rim: preferenceInd
- cda: .preferenceInd
|
generalPractitioner | | 0..* | Reference(http://hl7.org/fhir/StructureDefinition/Organization | http://hl7.org/fhir/StructureDefinition/Practitioner) | There are no (further) constraints on this element Element idPatient:uscorepatient.generalPractitioner Short descriptionPatient's nominated primary care provider Alternate namescareProvider DefinitionPatient's nominated care provider.
CommentsThis may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disablity setting, or even organization that will provide people to perform the care provider roles.
It is not to be used to record Care Teams, these should be in a CareTeam resource that may be linked to the CarePlan or EpisodeOfCare resources.
Data typeReference(http://hl7.org/fhir/StructureDefinition/Organization | http://hl7.org/fhir/StructureDefinition/Practitioner) Mappings- v2: PD1-4
- rim: subjectOf.CareEvent.performer.AssignedEntity
- cda: n/a
|
managingOrganization | Σ | 0..1 | Reference(http://hl7.org/fhir/StructureDefinition/Organization) | There are no (further) constraints on this element Element idPatient:uscorepatient.managingOrganization Short descriptionOrganization that is the custodian of the patient record DefinitionOrganization that is the custodian of the patient record.
RequirementsNeed to know who recognizes this patient record, manages and updates it.
CommentsThere 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).
Data typeReference(http://hl7.org/fhir/StructureDefinition/Organization) Mappings- rim: scoper
- cda: .providerOrganization
|
link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this element Element idPatient:uscorepatient.link Short descriptionLink to another patient resource that concerns the same actual person DefinitionLink to another patient resource that concerns the same actual patient.
RequirementsThere 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.
CommentsThere is no assumption that linked patient records have mutual links.
This element is labelled as a modifier because it may not be the main Patient resource, and the referenced patient should be used instead of this Patient record. This is when the link.type value is 'replaced-by'.
Data typeBackboneElement Constraints- ele-1: All FHIR elements must have a @value or children
children().count() > id.count() Mappings- rim: outboundLink
- cda: n/a
|
id | | 0..1 | string | There are no (further) constraints on this element Element idPatient:uscorepatient.link.id Short descriptionxml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Data typestring Mappings |
extension | | 0..* | Extension | There are no (further) constraints on this element Element idPatient:uscorepatient.link.extension Short descriptionAdditional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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.
CommentsThere 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.
Data typeExtension Mappings |
modifierExtension | Σ ?! | 0..* | Extension | There are no (further) constraints on this element Element idPatient:uscorepatient.link.modifierExtension Short descriptionExtensions that cannot be ignored Alternate namesextensions, user content, modifiers DefinitionMay 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.
CommentsThere 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.
Data typeExtension Mappings |
other | Σ | 1..1 | Reference(http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/RelatedPerson) | There are no (further) constraints on this element Element idPatient:uscorepatient.link.other Short descriptionThe other patient or related person resource that the link refers to DefinitionThe other patient resource that the link refers to.
CommentsReferencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.
Data typeReference(http://hl7.org/fhir/StructureDefinition/Patient | http://hl7.org/fhir/StructureDefinition/RelatedPerson) Mappings- v2: PID-3, MRG-1
- rim: id
- cda: n/a
|
type | Σ | 1..1 | codeBinding | There are no (further) constraints on this element Element idPatient:uscorepatient.link.type Short descriptionreplaced-by | replaces | refer | seealso - type of link DefinitionThe type of link between this patient resource and another patient resource.
Data typecode BindingThe type of link between this patient resource and another patient resource. http://hl7.org/fhir/ValueSet/link-type (required) Mappings |