| Patient | I |  | Patient | There are no (further) constraints on this elementElement IdShort description Information about an individual or animal receiving health care servicesAlternate names SubjectOfCare Client ResidentDefinition Data TypeDemographics and other administrative information about an individual or animal receiving care or other health-related services.PatientConstraints Mappingsdom-2:If the resource is contained in another resource, it SHALL NOT contain nested Resources
 contained.contained.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 or SHALL refer to the containing resource
 contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()dom-6:A resource should have narrative for robust management
 text.`div`.exists()dom-5:If a resource is contained in another resource, it SHALL NOT have a security label
 contained.meta.security.empty()
rim:Entity. Role, or Actrim:Patient[classCode=PAT]cda:ClinicalDocument.recordTarget.patientRole
 | 
| extension | I | 0..* | Extension | Element IdShort description Additional content defined by implementationsAlternate names extensions, user contentDefinition CommentsMay be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Data TypeThere 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.ExtensionSliced: Unordered, Open, by url(Value)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| birthPlace | I | 0..1 | Extension(Address) | Element Id Short descriptionPatient.extension:birthPlaceThe registered place of birth of the patient.Alternate names extensions, user contentDefinition CommentsThe registered place of birth of the patient.Data TypeThere 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.Extension(Address)Extension URL http://hl7.org/fhir/StructureDefinition/patient-birthPlaceConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| url |  | 1..1 | System.StringFixed Value | There are no (further) constraints on this elementElement Id Short descriptionPatient.extension:birthPlace.urlidentifies the meaning of the extensionDefinition CommentsSource of the definition for the extension code - a logical name or a URL.Data TypeThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.System.StringFixed Value 
Mappingshttp://hl7.org/fhir/StructureDefinition/patient-birthPlace | 
| value[x] |  | 1..1 |  | Element Id Short descriptionPatient.extension:birthPlace.value[x]The registered place of birth of the patient.Definition ConstraintsValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| valueAddress |  |  | Address | There are no (further) constraints on this elementData Type Address | 
| birthSex | I | 0..1 | Extension(code) | Element Id Short descriptionPatient.extension:birthSexThe patient's phenotypic sex at birth.Alternate names extensions, user contentDefinition CommentsThe patient's phenotypic sex at birth.Data TypeThere 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.Extension(code)Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-BirthSexConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| cadavericDonor | I | 0..1 | Extension(boolean) | Element Id Short descriptionPatient.extension:cadavericDonorPost-mortem donor status.Alternate names extensions, user contentDefinition CommentsFlag indicating whether the patient authorized the donation of body parts after death.Data TypeThere 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.Extension(boolean)Extension URL http://hl7.org/fhir/StructureDefinition/patient-cadavericDonorConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| url |  | 1..1 | System.StringFixed Value | There are no (further) constraints on this elementElement Id Short descriptionPatient.extension:cadavericDonor.urlidentifies the meaning of the extensionDefinition CommentsSource of the definition for the extension code - a logical name or a URL.Data TypeThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.System.StringFixed Value 
Mappingshttp://hl7.org/fhir/StructureDefinition/patient-cadavericDonor | 
| value[x] |  | 1..1 |  | Element Id Short descriptionPatient.extension:cadavericDonor.value[x]Post-mortem donor status.Definition ConstraintsFlag indicating whether the patient authorized the donation of body parts after death.Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| valueBoolean |  |  | boolean | There are no (further) constraints on this elementData Type boolean | 
| contactPreference | I | 0..1 | Extension(Complex) | Element Id Short descriptionPatient.extension:contactPreferenceThe preferred method of contact, contact times and written communication format given by a Patient or Related Person.Alternate names extensions, user contentDefinition CommentsThe preferred method of contact, contact times and written communication format given by a Patient or Related Person.Data TypeThere 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.Extension(Complex)Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactPreferenceConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| deathNotificationStatus | I | 0..1 | Extension(Complex) | Element Id Short descriptionPatient.extension:deathNotificationStatusThe patient's death notification status.Alternate names extensions, user contentDefinition CommentsThe patient's death notification status.Data TypeThere 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.Extension(Complex)Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-DeathNotificationStatusConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| ethnicCategory | I | 0..1 | Extension(CodeableConcept) | Element Id Short descriptionPatient.extension:ethnicCategoryThe ethnicity of the subjectAlternate names extensions, user contentDefinition CommentsThe ethnicity of the subject.Data TypeThere 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.Extension(CodeableConcept)Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-EthnicCategoryConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| residentialStatus | I | 0..1 | Extension(CodeableConcept) | Element Id Short descriptionPatient.extension:residentialStatusThe residential status of the patient.Alternate names extensions, user contentDefinition CommentsThe residential status of the patient. For example if this patient is a UK resident.Data TypeThere 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.Extension(CodeableConcept)Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ResidentialStatusConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| patientInterpreterRequired | I | 0..1 | Extension(boolean) | Element Id Short descriptionPatient.extension:patientInterpreterRequiredWhether the patient needs an interpreterAlternate names extensions, user contentDefinition CommentsThis Patient requires an interpreter to communicate healthcare information to the practitioner.Data TypeThe Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required.Extension(boolean)Extension URL http://hl7.org/fhir/StructureDefinition/patient-interpreterRequiredConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| url |  | 1..1 | System.StringFixed Value | There are no (further) constraints on this elementElement Id Short descriptionPatient.extension:patientInterpreterRequired.urlidentifies the meaning of the extensionDefinition CommentsSource of the definition for the extension code - a logical name or a URL.Data TypeThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.System.StringFixed Value 
Mappingshttp://hl7.org/fhir/StructureDefinition/patient-interpreterRequired | 
| value[x] |  | 1..1 |  | Element Id Short descriptionPatient.extension:patientInterpreterRequired.value[x]Indicator showing whether the patient needs an interpreterDefinition ConstraintsIndicator showing if this Patient requires an interpreter to communicate healthcare information to the practitioner.Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| valueBoolean |  |  | boolean | There are no (further) constraints on this elementData Type boolean | 
| identifier | Σ | 0..* | Identifier | Element IdShort description An identifier for this patientDefinition RequirementsAn identifier for this patient.Data TypePatients are almost always assigned specific numerical identifiers.IdentifierSliced: Unordered, Open, by system(Value)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:CX / EI (occasionally, more often EI maps to a resource id or a URL)rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs.  Also maps to Role[classCode=IDENT]servd:Identifierw5:FiveWs.identifierv2:PID-3rim:idcda:.id
 | 
| nhsNumber | Σ | 0..1 | Identifier | Element Id Short descriptionPatient.identifier:nhsNumberThe patient's NHS numberDefinition RequirementsAn identifier for this patient.Data TypePatients are almost always assigned specific numerical identifiers.IdentifierConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:CX / EI (occasionally, more often EI maps to a resource id or a URL)rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs.  Also maps to Role[classCode=IDENT]servd:Identifierw5:FiveWs.identifierv2:PID-3rim:idcda:.id
 | 
| extension | I | 0..* | Extension | Element Id Short descriptionPatient.identifier:nhsNumber.extensionAdditional content defined by implementationsAlternate names extensions, user contentDefinition CommentsMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Data TypeThere 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.ExtensionSliced: Unordered, Open, by url(Value)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| nhsNumberVerificationStatus | I | 0..1 | Extension(CodeableConcept) | Element Id Short descriptionPatient.identifier:nhsNumber.extension:nhsNumberVerificationStatusNHS number verification statusAlternate names extensions, user contentDefinition CommentsThe verification/tracing status of the NHS number.Data TypeThere 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.Extension(CodeableConcept)Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-NHSNumberVerificationStatusConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.identifier:nhsNumber.useusual | official | temp | secondary | old (If known)Definition RequirementsThe purpose of this identifier.CommentsAllows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.Data TypeApplications can assume that an identifier is permanent unless it explicitly says that it is temporary.codeBinding Identifies the purpose for this identifier, if known .IdentifierUse (required)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:N/Arim:Role.code or implied by context
 | 
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.identifier:nhsNumber.typeDescription of identifierDefinition RequirementsA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.CommentsAllows users to make use of identifiers when the identifier system is not known.Data TypeThis 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.CodeableConceptBinding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.Identifier Type Codes (extensible)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:CE/CNE/CWErim:CDorim:fhir:CodeableConcept rdfs:subClassOf dt:CDv2:CX.5rim:Role.code or implied by context
 | 
| system | Σ | 1..1 | uriFixed Value | Element Id Short descriptionPatient.identifier:nhsNumber.systemThe namespace for the identifier valueDefinition RequirementsEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.CommentsThere 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 TypeIdentifier.system is always case sensitive.uriConstraints Fixed Valueele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Mappingshttps://fhir.nhs.uk/Id/nhs-number rim:n/av2:CX.4 / EI-2-4rim:II.root or Role.id.rootservd:./IdentifierType
 | 
| value | Σ | 1..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.identifier:nhsNumber.valueThe value that is uniqueDefinition CommentsThe portion of the identifier typically relevant to the user and which is unique within the context of the system.Data TypeIf 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.stringConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Mappings
 rim:n/av2:CX.1 / EI.1rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)servd:./Value
 | 
| period | Σ I | 0..1 | Period | There are no (further) constraints on this elementElement Id Short descriptionPatient.identifier:nhsNumber.periodTime period when id is/was valid for useDefinition CommentsTime period during which identifier is/was valid for use.Data TypeA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.PeriodConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())per-1:If present, start SHALL have a lower value than end
 start.hasValue().not() or end.hasValue().not() or (start <= end)
rim:n/av2:DRrim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]v2:CX.7 + CX.8rim:Role.effectiveTime or implied by contextservd:./StartDate and ./EndDate
 | 
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element Id Short descriptionPatient.identifier:nhsNumber.assignerOrganization that issued id (may be just text)Definition CommentsOrganization that issued/manages the identifier.Data TypeThe Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.Reference(UK Core Organization)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ref-1:SHALL have a contained resource if a local reference is provided
 reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
rim:n/arim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)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.scoperservd:./IdentifierIssuingAuthority
 | 
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this elementElement IdShort description Whether this patient's record is in active useDefinition RequirementsWhether this patient record is in active use.
Many systems use this property to mark as non-current patients, such as those that have not been seen for a period of time based on an organization's business rules. It is often used to filter patient lists to exclude inactive patients Deceased patients may also be marked as inactive for the same reasons, but may be active for some time after death.CommentsNeed to be able to mark a patient record as not to be used because it was created in error.Data TypeIf a record is inactive, and linked to an active record, then future patient/record updates should occur on the other patient.booleanConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/aw5:FiveWs.statusrim:statusCodecda:n/a
 | 
| name | Σ | 0..* | HumanName | There are no (further) constraints on this elementElement IdShort description A name associated with the patientDefinition RequirementsA name associated with the individual.CommentsNeed to be able to track the patient by multiple names. Examples are your official name and a partner name.Data TypeA 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.HumanNameConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:XPNrim:EN (actually, PN)servd:ProviderNamev2:PID-5, PID-9rim:namecda:.patient.name
 | 
| telecom | Σ I | 0..* | ContactPoint | There are no (further) constraints on this elementElement IdShort description A contact detail for the individualDefinition RequirementsA contact detail (e.g. a telephone number or an email address) by which the individual may be contacted.CommentsPeople have (primary) ways to contact them in some way such as phone, email.Data TypeA 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 might 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).ContactPointConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())cpt-2:A system is required if a value is provided.
 value.empty() or system.exists()
rim:n/av2:XTNrim:TELservd:ContactPointv2:PID-13, PID-14, PID-40rim:telecomcda:.telecom
 | 
| system | Σ I | 0..1 | codeBinding | There are no (further) constraints on this elementElement IdShort description phone | fax | email | pager | url | sms | otherDefinition CommentsTelecommunications form for contact point - what communications system is required to make use of the contact.Data TypeNote that FHIR strings SHALL NOT exceed 1MB in sizecodeBinding Telecommunications form for contact point.ContactPointSystem (required)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:XTN.3rim:./schemeservd:./ContactPointType
 | 
| extension | I | 0..* | Extension | Element Id Short descriptionPatient.telecom.system.extensionAdditional content defined by implementationsAlternate names extensions, user contentDefinition CommentsMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Data TypeThere 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.ExtensionSliced: Unordered, Open, by url(Value)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| otherContactSystem | I | 0..1 | Extension(Coding) | Element Id Short descriptionPatient.telecom.system.extension:otherContactSystemOther contact systemAlternate names extensions, user contentDefinition CommentsOther contact system value which extends the system element in the ContactPoint datatype.Data TypeThere 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.Extension(Coding)Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystemConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| value | Σ | 0..1 | string | There are no (further) constraints on this elementElement IdShort description The actual contact point detailsDefinition RequirementsThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).CommentsNeed to support legacy numbers that are not in a tightly controlled format.Data TypeAdditional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.stringConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:XTN.1 (or XTN.12)rim:./urlservd:./Value
 | 
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this elementElement IdShort description home | work | temp | old | mobile - purpose of this contact pointDefinition RequirementsIdentifies the purpose for the contact point.CommentsNeed to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.Data TypeApplications can assume that a contact is current unless it explicitly says that it is temporary or old.codeBinding Use of contact point.ContactPointUse (required)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:XTN.2 - but often indicated by fieldrim:unique(./use)servd:./ContactPointPurpose
 | 
| rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this elementElement IdShort description Specify preferred order of use (1 = highest)Definition CommentsSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.Data TypeNote that rank does not necessarily follow the order in which the contacts are represented in the instance.positiveIntConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| period | Σ I | 0..1 | Period | There are no (further) constraints on this elementElement IdShort description Time period when the contact point was/is in useDefinition CommentsTime period when the contact point was/is in use.Data TypeA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.PeriodConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())per-1:If present, start SHALL have a lower value than end
 start.hasValue().not() or end.hasValue().not() or (start <= end)
rim:n/av2:DRrim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]v2:N/Arim:./usablePeriod[type="IVL<TS>"]servd:./StartDate and ./EndDate
 | 
| gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this elementElement IdShort description male | female | other | unknownDefinition RequirementsAdministrative Gender - the gender that the patient is considered to have for administration and record keeping purposes.CommentsNeeded for identification of the individual, in combination with (at least) name and birth date.Data TypeThe gender might 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 male and female, though the vast majority of systems and contexts only support male and female.  Systems providing decision support or enforcing business rules should ideally do this on the basis of Observations dealing with the specific sex or gender aspect of interest (anatomical, chromosomal, 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, chromosomal and other gender aspects.  For example, an alert about a hysterectomy on a male should be handled as a warning or overridable error, not a "hard" error.  See the Patient Gender and Sex section for additional information about communicating patient gender and sex.codeBinding The gender of a person used for administrative purposes.AdministrativeGender (required)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:PID-8rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGendercda:.patient.administrativeGenderCode
 | 
| birthDate | Σ | 0..1 | date | There are no (further) constraints on this elementElement IdShort description The date of birth for the individualDefinition RequirementsThe date of birth for the individual.CommentsAge of the individual drives many clinical processes.Data TypeAt 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 maternity/infant care systems).dateConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:PID-7rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/birthTimecda:.patient.birthTimeloinc:21112-8
 | 
| extension | I | 0..* | Extension | Element Id Short descriptionPatient.birthDate.extensionAdditional content defined by implementationsAlternate names extensions, user contentDefinition CommentsMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Data TypeThere 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.ExtensionSliced: Unordered, Open, by url(Value)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| birthTime | I | 0..1 | Extension(dateTime) | Element Id Short descriptionPatient.birthDate.extension:birthTimeTime of day of birth.Alternate names extensions, user contentDefinition CommentsThe time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively.Data TypeThere 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.Extension(dateTime)Extension URL http://hl7.org/fhir/StructureDefinition/patient-birthTimeConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| url |  | 1..1 | System.StringFixed Value | There are no (further) constraints on this elementElement Id Short descriptionPatient.birthDate.extension:birthTime.urlidentifies the meaning of the extensionDefinition CommentsSource of the definition for the extension code - a logical name or a URL.Data TypeThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.System.StringFixed Value 
Mappingshttp://hl7.org/fhir/StructureDefinition/patient-birthTime | 
| value[x] |  | 1..1 |  | Element Id Short descriptionPatient.birthDate.extension:birthTime.value[x]Time of day of birth.Definition ConstraintsThe time of day that the patient was born. This includes the date to ensure that the timezone information can be communicated effectively.Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| valueDateTime |  |  | dateTime | There are no (further) constraints on this elementData Type dateTime | 
| deceased[x] | Σ ?! | 0..1 |  | There are no (further) constraints on this elementElement IdShort description Indicates if the individual is deceased or notDefinition RequirementsIndicates if the individual is deceased or not.CommentsThe 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.ConstraintsIf 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.Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:PID-30  (bool) and PID-29 (datetime)rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedInd, player[classCode=PSN|ANM and determinerCode=INSTANCE]/deceasedTimecda:n/a
 | 
| deceasedBoolean |  |  | boolean | There are no (further) constraints on this elementData Type boolean | 
| deceasedDateTime |  |  | dateTime | There are no (further) constraints on this elementData Type dateTime | 
| address | Σ | 0..* | Address | Element IdShort description An address for the individualDefinition RequirementsAn address for the individualCommentsMay need to keep track of patient addresses for contacting, billing or reporting requirements and also to help with identification.Data TypePatient may have multiple addresses with different uses or applicable periods.AddressConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:XADrim:ADservd:Addressv2:PID-11rim:addrcda:.addr
 | 
| extension | I | 0..* | Extension | Element Id Short descriptionPatient.address.extensionAdditional content defined by implementationsAlternate names extensions, user contentDefinition CommentsMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Data TypeThere 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.ExtensionSliced: Unordered, Open, by url(Value)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| addressKey | I | 0..* | Extension(Complex) | Element Id Short descriptionPatient.address.extension:addressKeyA patient's address key and typeAlternate names extensions, user contentDefinition CommentsA patient's address key and type.Data TypeThere 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.Extension(Complex)Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKeyConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this elementElement IdShort description home | work | temp | old | billing - purpose of this addressDefinition RequirementsThe purpose of this address.CommentsAllows an appropriate address to be chosen from a list of many.Data TypeApplications can assume that an address is current unless it explicitly says that it is temporary or old.codeBinding The use of an address.AddressUse (required)Constraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Mappings
 rim:n/av2:XAD.7rim:unique(./use)servd:./AddressPurpose
 | 
| type | Σ | 0..1 | codeBinding | There are no (further) constraints on this elementElement IdShort description postal | physical | bothDefinition CommentsDistinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both.Data TypeThe definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource).codeBinding The type of an address (physical / postal).AddressType (required)Constraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Mappings
 rim:n/av2:XAD.18rim:unique(./use)vcard:address type parameter
 | 
| text | Σ | 0..1 | string | There are no (further) constraints on this elementElement IdShort description Text representation of the addressDefinition RequirementsSpecifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts.CommentsA renderable, unencoded form.Data TypeCan provide both a text representation and parts. Applications updating an address SHALL ensure that  when both text and parts are present,  no content is included in the text that isn't found in a part.stringConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
General137 Nowhere Street, Erewhon 9132 Mappings
 rim:n/av2:XAD.1 + XAD.2 + XAD.3 + XAD.4 + XAD.5 + XAD.6rim:./formattedvcard:address label parameter
 | 
| line | Σ | 0..* | string | There are no (further) constraints on this elementElement IdShort description Street name, number, direction & P.O. Box etc.Definition CommentsThis component contains the house number, apartment number, street name, street direction,  P.O. Box number, delivery hints, and similar address information.Data TypeNote that FHIR strings SHALL NOT exceed 1MB in sizestringConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
General137 Nowhere Street Mappings
 rim:n/av2:XAD.1 + XAD.2 (note: XAD.1 and XAD.2 have different meanings for a company address than for a person address)rim:AD.part[parttype = AL]vcard:streetservd:./StreetAddress (newline delimitted)
 | 
| city | Σ | 0..1 | string | There are no (further) constraints on this elementElement IdShort description Name of city, town etc.Alternate names MunicpalityDefinition CommentsThe name of the city, town, suburb, village or other community or delivery center.Data TypeNote that FHIR strings SHALL NOT exceed 1MB in sizestringConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Mappings
 rim:n/av2:XAD.3rim:AD.part[parttype = CTY]vcard:localityservd:./Jurisdiction
 | 
| district | Σ | 0..1 | string | There are no (further) constraints on this elementElement IdShort description District name (aka county)Alternate names CountyDefinition CommentsThe name of the administrative area (county).Data TypeDistrict is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead.stringConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Mappings
 rim:n/av2:XAD.9rim:AD.part[parttype = CNT | CPA]
 | 
| state | Σ | 0..1 | string | There are no (further) constraints on this elementElement IdShort description Sub-unit of country (abbreviations ok)Alternate names Province, TerritoryDefinition CommentsSub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes).Data TypeNote that FHIR strings SHALL NOT exceed 1MB in sizestringConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:XAD.4rim:AD.part[parttype = STA]vcard:regionservd:./Region
 | 
| postalCode | Σ | 0..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.address.postalCodePostal code for areaAlternate names ZipDefinition CommentsA postal code designating a region defined by the postal service.Data TypeNote that FHIR strings SHALL NOT exceed 1MB in sizestringConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Mappings
 rim:n/av2:XAD.5rim:AD.part[parttype = ZIP]vcard:codeservd:./PostalIdentificationCode
 | 
| country | Σ | 0..1 | string | There are no (further) constraints on this elementElement IdShort description Country (e.g. can be ISO 3166 2 or 3 letter code)Definition CommentsCountry - a nation as commonly understood or generally accepted.Data TypeISO 3166 3 letter codes can be used in place of a human readable country name.stringConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:XAD.6rim:AD.part[parttype = CNT]vcard:countryservd:./Country
 | 
| period | Σ I | 0..1 | Period | There are no (further) constraints on this elementElement IdShort description Time period when address was/is in useDefinition RequirementsTime period when address was/is in use.CommentsAllows addresses to be placed in historical context.Data TypeA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.PeriodConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())per-1:If present, start SHALL have a lower value than end
 start.hasValue().not() or end.hasValue().not() or (start <= end)
General{
  "start": "2010-03-23",
  "end": "2010-07-01"
} Mappings
 rim:n/av2:DRrim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]v2:XAD.12 / XAD.13 + XAD.14rim:./usablePeriod[type="IVL<TS>"]servd:./StartDate and ./EndDate
 | 
| maritalStatus |  | 0..1 | CodeableConceptBinding | Element IdShort description Marital (civil) status of a patientDefinition RequirementsThis field contains a patient's most recent marital (civil) status.CommentsMost, if not all systems capture it.Data TypeNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.CodeableConceptBinding An indicator to identify the legal marital status of a personUKCorePersonMaritalStatusCode (extensible)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:CE/CNE/CWErim:CDorim:fhir:CodeableConcept rdfs:subClassOf dt:CDv2:PID-16rim:player[classCode=PSN]/maritalStatusCodecda:.patient.maritalStatusCode
 | 
| multipleBirth[x] |  | 0..1 |  | There are no (further) constraints on this elementElement IdShort description Whether patient is part of a multiple birthDefinition RequirementsIndicates whether the patient is part of a multiple (boolean) or indicates the actual birth order (integer).CommentsFor disambiguation of multiple-birth children, especially relevant where the care provider doesn't meet the patient, such as labs.ConstraintsWhere the valueInteger is provided, the number is the birth number in the sequence. E.g. The middle birth in triplets would be valueInteger=2 and the third born would have valueInteger=3 If a boolean value was provided for this triplets example, then all 3 patient records would have valueBoolean=true (the ordering is not indicated).Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:PID-24 (bool), PID-25 (integer)rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthInd,  player[classCode=PSN|ANM and determinerCode=INSTANCE]/multipleBirthOrderNumbercda:n/a
 | 
| multipleBirthBoolean |  |  | boolean | There are no (further) constraints on this elementData Type boolean | 
| multipleBirthInteger |  |  | integer | There are no (further) constraints on this elementData Type integer | 
| photo | I | 0..* | Attachment | There are no (further) constraints on this elementElement IdShort description Image of the patientDefinition Requirements CommentsMany EHR systems have the capability to capture an image of the patient. Fits with newer social media usage too.Data TypeGuidelines: 
Use id photos, not clinical photos.Limit dimensions to thumbnail.Keep byte count low to ease resource updates.AttachmentConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())att-1:If the Attachment has data, it SHALL have a contentType
 data.empty() or contentType.exists()
rim:n/av2:ED/RPrim:EDv2:OBX-5 - needs a profilerim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/desccda:n/a
 | 
| contact | I | 0..* | BackboneElement | There are no (further) constraints on this elementElement IdShort description A contact party (e.g. guardian, partner, friend) for the patientDefinition RequirementsA contact party (e.g. guardian, partner, friend) for the patient.CommentsNeed to track people you can contact about the patient.Data TypeContact 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.BackboneElementConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (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()
rim:n/arim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/scopedRole[classCode=CON]cda:n/a
 | 
| extension | I | 0..* | Extension | Element Id Short descriptionPatient.contact.extensionAdditional content defined by implementationsAlternate names extensions, user contentDefinition CommentsMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Data TypeThere 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.ExtensionSliced: Unordered, Open, by url(Value)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| contactRank | I | 0..1 | Extension(positiveInt) | Element Id Short descriptionPatient.contact.extension:contactRankPreferred ranking or order of contact applied to a contact on a patient's contact listAlternate names extensions, user contentDefinition CommentsThe preferred ranking or order of contact applied to a contact on a patient's contact list.Data TypeThere 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.Extension(positiveInt)Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRankConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| copyCorrespondenceIndicator | I | 0..1 | Extension(boolean) | Element Id Short descriptionPatient.contact.extension:copyCorrespondenceIndicatorIndicator showing that a patient's contact or related person SHALL be copied in to patient correspondenceAlternate names extensions, user contentDefinition CommentsExtension carrying a boolean indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence.Data TypeThere 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.Extension(boolean)Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-CopyCorrespondenceIndicatorConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| relationship |  | 0..* | CodeableConceptBinding | Element Id Short descriptionPatient.contact.relationshipThe kind of relationshipDefinition RequirementsThe nature of the relationship between the patient and the contact person.CommentsUsed to determine which contact person is the most relevant to approach, depending on circumstances.Data TypeNot all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.CodeableConceptBinding The nature of the relationship between a patient and a contact person for that patient.UKCorePersonRelationshipType (extensible)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:CE/CNE/CWErim:CDorim:fhir:CodeableConcept rdfs:subClassOf dt:CDv2:NK1-7, NK1-3rim:codecda:n/a
 | 
| name |  | 0..1 | HumanName | There are no (further) constraints on this elementElement IdShort description A name associated with the contact personDefinition RequirementsA name associated with the contact person.CommentsContact persons need to be identified by name, but it is uncommon to need details about multiple other names for that contact person.Data TypeNames may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts might or might not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely.HumanNameConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:XPNrim:EN (actually, PN)servd:ProviderNamev2:NK1-2rim:namecda:n/a
 | 
| telecom | I | 0..* | ContactPoint | There are no (further) constraints on this elementElement IdShort description A contact detail for the personDefinition RequirementsA contact detail for the person, e.g. a telephone number or an email address.CommentsPeople have (primary) ways to contact them in some way such as phone, email.Data TypeContact 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.ContactPointConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())cpt-2:A system is required if a value is provided.
 value.empty() or system.exists()
rim:n/av2:XTNrim:TELservd:ContactPointv2:NK1-5, NK1-6, NK1-40rim:telecomcda:n/a
 | 
| system | Σ I | 0..1 | codeBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.contact.telecom.systemphone | fax | email | pager | url | sms | otherDefinition CommentsTelecommunications form for contact point - what communications system is required to make use of the contact.Data TypeNote that FHIR strings SHALL NOT exceed 1MB in sizecodeBinding Telecommunications form for contact point.ContactPointSystem (required)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:XTN.3rim:./schemeservd:./ContactPointType
 | 
| extension | I | 0..* | Extension | Element Id Short descriptionPatient.contact.telecom.system.extensionAdditional content defined by implementationsAlternate names extensions, user contentDefinition CommentsMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Data TypeThere 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.ExtensionSliced: Unordered, Open, by url(Value)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| otherContactSystem | I | 0..1 | Extension(Coding) | Element Id Short descriptionPatient.contact.telecom.system.extension:otherContactSystemOther contact systemAlternate names extensions, user contentDefinition CommentsOther contact system value which extends the system element in the ContactPoint datatype.Data TypeThere 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.Extension(Coding)Extension URL https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-OtherContactSystemConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| value | Σ | 0..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.contact.telecom.valueThe actual contact point detailsDefinition RequirementsThe actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address).CommentsNeed to support legacy numbers that are not in a tightly controlled format.Data TypeAdditional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value.stringConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:XTN.1 (or XTN.12)rim:./urlservd:./Value
 | 
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.contact.telecom.usehome | work | temp | old | mobile - purpose of this contact pointDefinition RequirementsIdentifies the purpose for the contact point.CommentsNeed to track the way a person uses this contact, so a user can choose which is appropriate for their purpose.Data TypeApplications can assume that a contact is current unless it explicitly says that it is temporary or old.codeBinding Use of contact point.ContactPointUse (required)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:XTN.2 - but often indicated by fieldrim:unique(./use)servd:./ContactPointPurpose
 | 
| rank | Σ | 0..1 | positiveInt | There are no (further) constraints on this elementElement Id Short descriptionPatient.contact.telecom.rankSpecify preferred order of use (1 = highest)Definition CommentsSpecifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values.Data TypeNote that rank does not necessarily follow the order in which the contacts are represented in the instance.positiveIntConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| period | Σ I | 0..1 | Period | There are no (further) constraints on this elementElement Id Short descriptionPatient.contact.telecom.periodTime period when the contact point was/is in useDefinition CommentsTime period when the contact point was/is in use.Data TypeA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.PeriodConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())per-1:If present, start SHALL have a lower value than end
 start.hasValue().not() or end.hasValue().not() or (start <= end)
rim:n/av2:DRrim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]v2:N/Arim:./usablePeriod[type="IVL<TS>"]servd:./StartDate and ./EndDate
 | 
| address |  | 0..1 | Address | There are no (further) constraints on this elementElement IdShort description Address for the contact personDefinition RequirementsAddress for the contact person.CommentsNeed to keep track where the contact person can be contacted per postal mail or visited.Data TypeNote: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates.  Postal addresses are often used as proxies for physical locations (also see the Location resource).AddressConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:XADrim:ADservd:Addressv2:NK1-4rim:addrcda:n/a
 | 
| gender |  | 0..1 | codeBinding | There are no (further) constraints on this elementElement IdShort description male | female | other | unknownDefinition RequirementsAdministrative Gender - the gender that the contact person is considered to have for administration and record keeping purposes.CommentsNeeded to address the person correctly.Data TypeNote that FHIR strings SHALL NOT exceed 1MB in sizecodeBinding The gender of a person used for administrative purposes.AdministrativeGender (required)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:NK1-15rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/administrativeGendercda:n/a
 | 
| organization | I | 0..1 | Reference(UK Core Organization) | Element Id Short descriptionPatient.contact.organizationOrganization that is associated with the contactDefinition RequirementsOrganization on behalf of which the contact is acting or for which the contact is working.CommentsFor guardians or business related contacts, the organization is relevant.Data TypeReferences SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.Reference(UK Core Organization)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ref-1:SHALL have a contained resource if a local reference is provided
 reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
rim:n/arim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)v2:NK1-13, NK1-30, NK1-31, NK1-32, NK1-41rim:scopercda:n/a
 | 
| reference | Σ I | 0..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.contact.organization.referenceLiteral reference, Relative, internal or absolute URLDefinition CommentsA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.Data TypeUsing absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries.   Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.stringConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.contact.organization.typeType the reference refers to (e.g. "Patient")Definition CommentsThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).Data TypeThis element is used to indicate the type of  the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.uriBinding Aa resource (or, for logical models, the URI of the logical model).ResourceType (extensible)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this elementElement Id Short descriptionPatient.contact.organization.identifierLogical reference, when literal reference is not knownDefinition CommentsAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.Data TypeWhen an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference.  For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport).  One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).IdentifierConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:CX / EI (occasionally, more often EI maps to a resource id or a URL)rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs.  Also maps to Role[classCode=IDENT]servd:Identifierrim:.identifier
 | 
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.contact.organization.identifier.useusual | official | temp | secondary | old (If known)Definition RequirementsThe purpose of this identifier.CommentsAllows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.Data TypeApplications can assume that an identifier is permanent unless it explicitly says that it is temporary.codeBinding Identifies the purpose for this identifier, if known .IdentifierUse (required)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:N/Arim:Role.code or implied by context
 | 
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.contact.organization.identifier.typeDescription of identifierDefinition RequirementsA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.CommentsAllows users to make use of identifiers when the identifier system is not known.Data TypeThis 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.CodeableConceptBinding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.Identifier Type Codes (extensible)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:CE/CNE/CWErim:CDorim:fhir:CodeableConcept rdfs:subClassOf dt:CDv2:CX.5rim:Role.code or implied by context
 | 
| system | Σ | 0..1 | uri | There are no (further) constraints on this elementElement Id Short descriptionPatient.contact.organization.identifier.systemThe namespace for the identifier valueDefinition RequirementsEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.CommentsThere 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 TypeIdentifier.system is always case sensitive.uriConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient Mappings
 rim:n/av2:CX.4 / EI-2-4rim:II.root or Role.id.rootservd:./IdentifierType
 | 
| value | Σ | 0..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.contact.organization.identifier.valueThe value that is uniqueDefinition CommentsThe portion of the identifier typically relevant to the user and which is unique within the context of the system.Data TypeIf 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.stringConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Mappings
 rim:n/av2:CX.1 / EI.1rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)servd:./Value
 | 
| period | Σ I | 0..1 | Period | There are no (further) constraints on this elementElement Id Short descriptionPatient.contact.organization.identifier.periodTime period when id is/was valid for useDefinition CommentsTime period during which identifier is/was valid for use.Data TypeA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.PeriodConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())per-1:If present, start SHALL have a lower value than end
 start.hasValue().not() or end.hasValue().not() or (start <= end)
rim:n/av2:DRrim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]v2:CX.7 + CX.8rim:Role.effectiveTime or implied by contextservd:./StartDate and ./EndDate
 | 
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element Id Short descriptionPatient.contact.organization.identifier.assignerOrganization that issued id (may be just text)Definition CommentsOrganization that issued/manages the identifier.Data TypeThe Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.Reference(UK Core Organization)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ref-1:SHALL have a contained resource if a local reference is provided
 reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
rim:n/arim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)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.scoperservd:./IdentifierIssuingAuthority
 | 
| display | Σ | 0..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.contact.organization.displayText alternative for the resourceDefinition CommentsPlain text narrative that identifies the resource in addition to the resource reference.Data TypeThis is generally not the same as the Resource.text of the referenced resource.  The purpose is to identify what's being referenced, not to fully describe it.stringConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| period | I | 0..1 | Period | There are no (further) constraints on this elementElement IdShort description The period during which this contact person or organization is valid to be contacted relating to this patientDefinition CommentsThe period during which this contact person or organization is valid to be contacted relating to this patient.Data TypeA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.PeriodConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())per-1:If present, start SHALL have a lower value than end
 start.hasValue().not() or end.hasValue().not() or (start <= end)
rim:n/av2:DRrim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]rim:effectiveTimecda:n/a
 | 
| communication |  | 0..* | BackboneElement | There are no (further) constraints on this elementElement IdShort description A language which may be used to communicate with the patient about his or her healthDefinition RequirementsA language which may be used to communicate with the patient about his or her health.CommentsIf a patient does not speak the local language, interpreters may be required, so languages spoken and proficiency are important things to keep track of both for patient and other persons of interest.Data TypeIf 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.BackboneElementConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/arim:LanguageCommunicationcda:patient.languageCommunication
 | 
| extension | I | 0..* | Extension | Element Id Short descriptionPatient.communication.extensionAdditional content defined by implementationsAlternate names extensions, user contentDefinition CommentsMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Data TypeThere 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.ExtensionSliced: Unordered, Open, by url(Value)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| proficiency | I | 0..1 | Extension(Complex) | Element Id Short descriptionPatient.communication.extension:proficiencyProficiency level of the communicationAlternate names extensions, user contentDefinition CommentsProficiency level of the communication.Data TypeThere 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.Extension(Complex)Extension URL http://hl7.org/fhir/StructureDefinition/patient-proficiencyConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| extension | I | 0..* | Extension | Element Id Short descriptionPatient.communication.extension:proficiency.extensionAdditional content defined by implementationsAlternate names extensions, user contentDefinition CommentsMay be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.Data TypeThere 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.ExtensionSliced: Unordered, Open, by url(Value)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| level | I | 0..1 | Extension | There are no (further) constraints on this elementElement Id Short descriptionPatient.communication.extension:proficiency.extension:levelThe proficiency level of the communicationAlternate names extensions, user contentDefinition CommentsHow well the patient can communicate this communication (good, poor, etc.).Data TypeThere 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.ExtensionConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| url |  | 1..1 | uriFixed Value | There are no (further) constraints on this elementElement Id Short descriptionPatient.communication.extension:proficiency.extension:level.urlidentifies the meaning of the extensionDefinition CommentsSource of the definition for the extension code - a logical name or a URL.Data TypeThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.uriFixed Value Mappings | 
| value[x] |  | 1..1 | Binding | Element Id Short descriptionPatient.communication.extension:proficiency.extension:level.value[x]The proficiency level for the communicationDefinition BindingThe proficiency level for the communication.The proficiency level for the communication.v3.LanguageAbilityProficiency (preferred)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| valueCoding |  |  | Coding | There are no (further) constraints on this elementData Type Coding | 
| type | I | 0..* | Extension | There are no (further) constraints on this elementElement Id Short descriptionPatient.communication.extension:proficiency.extension:typeThe proficiency type of the communicationAlternate names extensions, user contentDefinition CommentsWhat type of communication for the proficiency (spoken, written, etc.).Data TypeThere 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.ExtensionConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ext-1:Must have either extensions or value[x], not both
 extension.exists() != value.exists()
 | 
| url |  | 1..1 | uriFixed Value | There are no (further) constraints on this elementElement Id Short descriptionPatient.communication.extension:proficiency.extension:type.urlidentifies the meaning of the extensionDefinition CommentsSource of the definition for the extension code - a logical name or a URL.Data TypeThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.uriFixed Value Mappings | 
| value[x] |  | 1..1 | Binding | Element Id Short descriptionPatient.communication.extension:proficiency.extension:type.value[x]The proficiency type for the communicationDefinition BindingThe proficiency type for the communication.The proficiency type for the communication.v3.LanguageAbilityMode (preferred)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| valueCoding |  |  | Coding | There are no (further) constraints on this elementData Type Coding | 
| url |  | 1..1 | System.StringFixed Value | There are no (further) constraints on this elementElement Id Short descriptionPatient.communication.extension:proficiency.urlidentifies the meaning of the extensionDefinition CommentsSource of the definition for the extension code - a logical name or a URL.Data TypeThe definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.System.StringFixed Value 
Mappingshttp://hl7.org/fhir/StructureDefinition/patient-proficiency | 
| value[x] |  | 0..0 |  | There are no (further) constraints on this elementElement Id Short descriptionPatient.communication.extension:proficiency.value[x]Value of extensionDefinition ConstraintsValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| language |  | 1..1 | CodeableConceptBinding | Element Id Short descriptionPatient.communication.languageA ValueSet that identifies the language used by a person.Definition RequirementsA ValueSet that identifies the language used by a person.CommentsMost systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.Data TypeThe 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.CodeableConceptBinding A ValueSet that identifies the language used by a person.UKCoreHumanLanguage (extensible)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:CE/CNE/CWErim:CDorim:fhir:CodeableConcept rdfs:subClassOf dt:CDv2:PID-15, LAN-2rim:player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/codecda:.languageCode
 | 
| preferred |  | 0..1 | boolean | There are no (further) constraints on this elementElement Id Short descriptionPatient.communication.preferredLanguage preference indicatorDefinition RequirementsIndicates whether or not the patient prefers this language (over other languages he masters up a certain level).CommentsPeople 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.Data TypeThis language is specifically identified for communicating healthcare information.booleanConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:PID-15rim:preferenceIndcda:.preferenceInd
 | 
| generalPractitioner | I | 0..* | Reference(UK Core Practitioner | UK Core Organization | UK Core PractitionerRole) | Element Id Short descriptionPatient.generalPractitionerPatient's nominated primary care providerAlternate names careProviderDefinition CommentsPatient's nominated care provider.Data TypeThis may be the primary care provider (in a GP context), or it may be a patient nominated care manager in a community/disability 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.
Multiple GPs may be recorded against the patient for various reasons, such as a student that has his home GP listed along with the GP at university during the school semesters, or a "fly-in/fly-out" worker that has the onsite GP also included with his home GP to remain aware of medical issues. Jurisdictions may decide that they can profile this down to 1 if desired, or 1 per type.Reference(UK Core Practitioner | UK Core Organization | UK Core PractitionerRole)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ref-1:SHALL have a contained resource if a local reference is provided
 reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
rim:n/arim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)v2:PD1-4rim:subjectOf.CareEvent.performer.AssignedEntitycda:n/a
 | 
| reference | Σ I | 0..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.generalPractitioner.referenceLiteral reference, Relative, internal or absolute URLDefinition CommentsA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.Data TypeUsing absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries.   Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.stringConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.generalPractitioner.typeType the reference refers to (e.g. "Patient")Definition CommentsThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).Data TypeThis element is used to indicate the type of  the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.uriBinding Aa resource (or, for logical models, the URI of the logical model).ResourceType (extensible)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this elementElement Id Short descriptionPatient.generalPractitioner.identifierLogical reference, when literal reference is not knownDefinition CommentsAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.Data TypeWhen an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference.  For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport).  One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).IdentifierConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:CX / EI (occasionally, more often EI maps to a resource id or a URL)rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs.  Also maps to Role[classCode=IDENT]servd:Identifierrim:.identifier
 | 
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.generalPractitioner.identifier.useusual | official | temp | secondary | old (If known)Definition RequirementsThe purpose of this identifier.CommentsAllows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.Data TypeApplications can assume that an identifier is permanent unless it explicitly says that it is temporary.codeBinding Identifies the purpose for this identifier, if known .IdentifierUse (required)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:N/Arim:Role.code or implied by context
 | 
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.generalPractitioner.identifier.typeDescription of identifierDefinition RequirementsA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.CommentsAllows users to make use of identifiers when the identifier system is not known.Data TypeThis 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.CodeableConceptBinding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.Identifier Type Codes (extensible)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:CE/CNE/CWErim:CDorim:fhir:CodeableConcept rdfs:subClassOf dt:CDv2:CX.5rim:Role.code or implied by context
 | 
| system | Σ | 0..1 | uri | There are no (further) constraints on this elementElement Id Short descriptionPatient.generalPractitioner.identifier.systemThe namespace for the identifier valueDefinition RequirementsEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.CommentsThere 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 TypeIdentifier.system is always case sensitive.uriConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient Mappings
 rim:n/av2:CX.4 / EI-2-4rim:II.root or Role.id.rootservd:./IdentifierType
 | 
| value | Σ | 0..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.generalPractitioner.identifier.valueThe value that is uniqueDefinition CommentsThe portion of the identifier typically relevant to the user and which is unique within the context of the system.Data TypeIf 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.stringConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Mappings
 rim:n/av2:CX.1 / EI.1rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)servd:./Value
 | 
| period | Σ I | 0..1 | Period | There are no (further) constraints on this elementElement Id Short descriptionPatient.generalPractitioner.identifier.periodTime period when id is/was valid for useDefinition CommentsTime period during which identifier is/was valid for use.Data TypeA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.PeriodConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())per-1:If present, start SHALL have a lower value than end
 start.hasValue().not() or end.hasValue().not() or (start <= end)
rim:n/av2:DRrim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]v2:CX.7 + CX.8rim:Role.effectiveTime or implied by contextservd:./StartDate and ./EndDate
 | 
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element Id Short descriptionPatient.generalPractitioner.identifier.assignerOrganization that issued id (may be just text)Definition CommentsOrganization that issued/manages the identifier.Data TypeThe Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.Reference(UK Core Organization)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ref-1:SHALL have a contained resource if a local reference is provided
 reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
rim:n/arim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)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.scoperservd:./IdentifierIssuingAuthority
 | 
| display | Σ | 0..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.generalPractitioner.displayText alternative for the resourceDefinition CommentsPlain text narrative that identifies the resource in addition to the resource reference.Data TypeThis is generally not the same as the Resource.text of the referenced resource.  The purpose is to identify what's being referenced, not to fully describe it.stringConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| managingOrganization | Σ I | 0..1 | Reference(UK Core Organization) | Element Id Short descriptionPatient.managingOrganizationOrganization that is the custodian of the patient recordDefinition RequirementsOrganization that is the custodian of the patient record.CommentsNeed to know who recognizes this patient record, manages and updates it.Data TypeThere 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).Reference(UK Core Organization)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ref-1:SHALL have a contained resource if a local reference is provided
 reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
rim:n/arim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)rim:scopercda:.providerOrganization
 | 
| reference | Σ I | 0..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.managingOrganization.referenceLiteral reference, Relative, internal or absolute URLDefinition CommentsA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.Data TypeUsing absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries.   Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.stringConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.managingOrganization.typeType the reference refers to (e.g. "Patient")Definition CommentsThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).Data TypeThis element is used to indicate the type of  the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.uriBinding Aa resource (or, for logical models, the URI of the logical model).ResourceType (extensible)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this elementElement Id Short descriptionPatient.managingOrganization.identifierLogical reference, when literal reference is not knownDefinition CommentsAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.Data TypeWhen an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference.  For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport).  One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).IdentifierConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:CX / EI (occasionally, more often EI maps to a resource id or a URL)rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs.  Also maps to Role[classCode=IDENT]servd:Identifierrim:.identifier
 | 
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.managingOrganization.identifier.useusual | official | temp | secondary | old (If known)Definition RequirementsThe purpose of this identifier.CommentsAllows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.Data TypeApplications can assume that an identifier is permanent unless it explicitly says that it is temporary.codeBinding Identifies the purpose for this identifier, if known .IdentifierUse (required)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:N/Arim:Role.code or implied by context
 | 
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.managingOrganization.identifier.typeDescription of identifierDefinition RequirementsA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.CommentsAllows users to make use of identifiers when the identifier system is not known.Data TypeThis 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.CodeableConceptBinding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.Identifier Type Codes (extensible)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:CE/CNE/CWErim:CDorim:fhir:CodeableConcept rdfs:subClassOf dt:CDv2:CX.5rim:Role.code or implied by context
 | 
| system | Σ | 0..1 | uri | There are no (further) constraints on this elementElement Id Short descriptionPatient.managingOrganization.identifier.systemThe namespace for the identifier valueDefinition RequirementsEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.CommentsThere 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 TypeIdentifier.system is always case sensitive.uriConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient Mappings
 rim:n/av2:CX.4 / EI-2-4rim:II.root or Role.id.rootservd:./IdentifierType
 | 
| value | Σ | 0..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.managingOrganization.identifier.valueThe value that is uniqueDefinition CommentsThe portion of the identifier typically relevant to the user and which is unique within the context of the system.Data TypeIf 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.stringConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Mappings
 rim:n/av2:CX.1 / EI.1rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)servd:./Value
 | 
| period | Σ I | 0..1 | Period | There are no (further) constraints on this elementElement Id Short descriptionPatient.managingOrganization.identifier.periodTime period when id is/was valid for useDefinition CommentsTime period during which identifier is/was valid for use.Data TypeA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.PeriodConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())per-1:If present, start SHALL have a lower value than end
 start.hasValue().not() or end.hasValue().not() or (start <= end)
rim:n/av2:DRrim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]v2:CX.7 + CX.8rim:Role.effectiveTime or implied by contextservd:./StartDate and ./EndDate
 | 
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element Id Short descriptionPatient.managingOrganization.identifier.assignerOrganization that issued id (may be just text)Definition CommentsOrganization that issued/manages the identifier.Data TypeThe Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.Reference(UK Core Organization)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ref-1:SHALL have a contained resource if a local reference is provided
 reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
rim:n/arim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)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.scoperservd:./IdentifierIssuingAuthority
 | 
| display | Σ | 0..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.managingOrganization.displayText alternative for the resourceDefinition CommentsPlain text narrative that identifies the resource in addition to the resource reference.Data TypeThis is generally not the same as the Resource.text of the referenced resource.  The purpose is to identify what's being referenced, not to fully describe it.stringConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| link | Σ ?! | 0..* | BackboneElement | There are no (further) constraints on this elementElement IdShort description Link to another patient resource that concerns the same actual personDefinition RequirementsLink to another patient resource that concerns the same actual patient.CommentsThere are multiple use cases: 
Duplicate patient records due to the clerical errors associated with the difficulties of identifying humans consistently, andDistribution of patient information across multiple servers.Data TypeThere is no assumption that linked patient records have mutual links.BackboneElementConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/arim:outboundLinkcda:n/a
 | 
| other | Σ I | 1..1 | Reference(UK Core Patient | UK Core RelatedPerson) | Element IdShort description The other patient or related person resource that the link refers toDefinition CommentsThe other patient resource that the link refers to.Data TypeReferencing a RelatedPerson here removes the need to use a Person record to associate a Patient and RelatedPerson as the same individual.Reference(UK Core Patient | UK Core RelatedPerson)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ref-1:SHALL have a contained resource if a local reference is provided
 reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
rim:n/arim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)v2:PID-3, MRG-1rim:idcda:n/a
 | 
| reference | Σ I | 0..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.link.other.referenceLiteral reference, Relative, internal or absolute URLDefinition CommentsA reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.Data TypeUsing absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries.   Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server.stringConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| type | Σ | 0..1 | uriBinding | There are no (further) constraints on this elementElement IdShort description Type the reference refers to (e.g. "Patient")Definition CommentsThe expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources).Data TypeThis element is used to indicate the type of  the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified.uriBinding Aa resource (or, for logical models, the URI of the logical model).ResourceType (extensible)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this elementElement Id Short descriptionPatient.link.other.identifierLogical reference, when literal reference is not knownDefinition CommentsAn identifier for the target resource. This is used when there is no way to reference the other resource directly, either because the entity it represents is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.Data TypeWhen an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference.  For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport).  One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any).IdentifierConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:CX / EI (occasionally, more often EI maps to a resource id or a URL)rim:II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs.  Also maps to Role[classCode=IDENT]servd:Identifierrim:.identifier
 | 
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.link.other.identifier.useusual | official | temp | secondary | old (If known)Definition RequirementsThe purpose of this identifier.CommentsAllows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.Data TypeApplications can assume that an identifier is permanent unless it explicitly says that it is temporary.codeBinding Identifies the purpose for this identifier, if known .IdentifierUse (required)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:N/Arim:Role.code or implied by context
 | 
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this elementElement Id Short descriptionPatient.link.other.identifier.typeDescription of identifierDefinition RequirementsA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.CommentsAllows users to make use of identifiers when the identifier system is not known.Data TypeThis 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.CodeableConceptBinding A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.Identifier Type Codes (extensible)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/av2:CE/CNE/CWErim:CDorim:fhir:CodeableConcept rdfs:subClassOf dt:CDv2:CX.5rim:Role.code or implied by context
 | 
| system | Σ | 0..1 | uri | There are no (further) constraints on this elementElement Id Short descriptionPatient.link.other.identifier.systemThe namespace for the identifier valueDefinition RequirementsEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.CommentsThere 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 TypeIdentifier.system is always case sensitive.uriConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Generalhttp://www.acme.com/identifiers/patient Mappings
 rim:n/av2:CX.4 / EI-2-4rim:II.root or Role.id.rootservd:./IdentifierType
 | 
| value | Σ | 0..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.link.other.identifier.valueThe value that is uniqueDefinition CommentsThe portion of the identifier typically relevant to the user and which is unique within the context of the system.Data TypeIf 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. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.stringConstraints Examplesele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
Mappings
 rim:n/av2:CX.1 / EI.1rim:II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)servd:./Value
 | 
| period | Σ I | 0..1 | Period | There are no (further) constraints on this elementElement Id Short descriptionPatient.link.other.identifier.periodTime period when id is/was valid for useDefinition CommentsTime period during which identifier is/was valid for use.Data TypeA Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). Period is not used for a duration (a measure of elapsed time). See Duration.PeriodConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())per-1:If present, start SHALL have a lower value than end
 start.hasValue().not() or end.hasValue().not() or (start <= end)
rim:n/av2:DRrim:IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]v2:CX.7 + CX.8rim:Role.effectiveTime or implied by contextservd:./StartDate and ./EndDate
 | 
| assigner | Σ I | 0..1 | Reference(UK Core Organization) | Element Id Short descriptionPatient.link.other.identifier.assignerOrganization that issued id (may be just text)Definition CommentsOrganization that issued/manages the identifier.Data TypeThe Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.Reference(UK Core Organization)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())ref-1:SHALL have a contained resource if a local reference is provided
 reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
rim:n/arim:The target of a resource reference is a RIM entry point (Act, Role, or Entity)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.scoperservd:./IdentifierIssuingAuthority
 | 
| display | Σ | 0..1 | string | There are no (further) constraints on this elementElement Id Short descriptionPatient.link.other.displayText alternative for the resourceDefinition CommentsPlain text narrative that identifies the resource in addition to the resource reference.Data TypeThis is generally not the same as the Resource.text of the referenced resource.  The purpose is to identify what's being referenced, not to fully describe it.stringConstraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
 | 
| type | Σ | 1..1 | codeBinding | There are no (further) constraints on this elementElement IdShort description replaced-by | replaces | refer | seealsoDefinition CommentsThe type of link between this patient resource and another patient resource.Data TypeNote that FHIR strings SHALL NOT exceed 1MB in sizecodeBinding The type of link between this patient resource and another patient resource.LinkType (required)Constraints Mappingsele-1:All FHIR elements must have a @value or children
 hasValue() or (children().count() > id.count())
rim:n/arim:typeCodecda:n/a
 |