Draft preBallot - This specification is under preBallot review and subject to change. It should not be used for implementation purposes. . . . . For a full list of available versions, see the Directory of published versions
RelatedPerson (CA-Core)
This profile is currently a placeholder which is mapped to to CACDI. Closer alignment between this profile and the logical data model will be sought in the next version of this implementation guide.
Links
Profile
Derived from
http://hl7.org/fhir/StructureDefinition/RelatedPerson
Examples
Description
This profile represents the constraints applied to the RelatedPerson resource by the CA Core+ project to represent the minimum expectations for the RelatedPerson resource when used to promote capacity building for functionality found across Canadian FHIR implementations. It is informed by the constraints of shared across CIHI pCHDCF data sets.
References to this resource
AllergyIntoleranceCACore, CommunicationCACore, DocumentReferenceCACore, EncounterCACore
Resource Content
RelatedPersonCACore (RelatedPerson) | I | RelatedPerson | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
active | Σ ?! | 0..1 | boolean |
patient | Σ | 1..1 | Reference(Patient) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
relationship | Σ | 0..* | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
name | Σ | 0..* | HumanName |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
text | Σ | 0..1 | string |
family | Σ | 1..1 | string |
given | Σ | 1..* | string |
prefix | Σ | 0..* | string |
suffix | Σ | 0..* | string |
period | Σ | 0..1 | Period |
telecom | Σ | 0..* | ContactPoint |
gender | Σ | 0..1 | codeBinding |
birthDate | Σ | 0..1 | date |
address | Σ | 0..* | Address |
photo | 0..* | Attachment | |
period | 0..1 | Period | |
communication | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
language | 1..1 | CodeableConceptBinding | |
preferred | 0..1 | boolean |
RelatedPersonCACore (RelatedPerson) | I | RelatedPerson | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 0..* | Identifier |
active | Σ ?! | 0..1 | boolean |
patient | Σ | 1..1 | Reference(Patient) |
id | 0..1 | string | |
extension | I | 0..* | Extension |
reference | Σ I | 1..1 | string |
type | Σ | 0..1 | uriBinding |
identifier | Σ | 0..1 | Identifier |
display | Σ | 0..1 | string |
relationship | Σ | 0..* | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 1..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
name | Σ | 0..* | HumanName |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
text | Σ | 0..1 | string |
family | Σ | 1..1 | string |
given | Σ | 1..* | string |
prefix | Σ | 0..* | string |
suffix | Σ | 0..* | string |
period | Σ | 0..1 | Period |
telecom | Σ | 0..* | ContactPoint |
gender | Σ | 0..1 | codeBinding |
birthDate | Σ | 0..1 | date |
address | Σ | 0..* | Address |
photo | 0..* | Attachment | |
period | 0..1 | Period | |
communication | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
language | 1..1 | CodeableConceptBinding | |
preferred | 0..1 | boolean |
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="relatedperson-ca-core" /> <url value="http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/relatedperson-ca-core" /> <name value="RelatedPersonCACore" /> <title value="RelatedPerson (CA-Core)" /> <status value="draft" /> <experimental value="false" /> <date value="2025-03-31" /> <publisher value="Canada Health Infoway" /> <contact> <name value="National Standards Release Centre" /> <telecom> <system value="url" /> <value value="http://www.infoway-inforoute.ca" /> </telecom> <telecom> <system value="email" /> <value value="standards@infoway-inforoute.ca" /> </telecom> </contact> <description value="This profile represents the constraints applied to the RelatedPerson resource by the CA Core+ project to represent the minimum expectations for the RelatedPerson resource when used to promote capacity building for functionality found across Canadian FHIR implementations. It is informed by the constraints of shared across CIHI pCHDCF data sets." /> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166" /> <code value="CA" /> </coding> </jurisdiction> <copyright value="Copyright © 2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="RelatedPerson" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> <derivation value="constraint" /> <snapshot> <element id="RelatedPerson"> <path value="RelatedPerson" /> <short value="A person that is related to a patient, but who is not a direct target of care" /> <definition value="Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process." /> <min value="0" /> <max value="*" /> <base> <path value="RelatedPerson" /> <min value="0" /> <max value="*" /> </base> <constraint> <key value="dom-2" /> <severity value="error" /> <human value="If the resource is contained in another resource, it SHALL NOT contain nested Resources" /> <expression value="contained.contained.empty()" /> <xpath value="not(parent::f:contained and f:contained)" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-3" /> <severity value="error" /> <human value="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" /> <expression value="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()" /> <xpath value="not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-4" /> <severity value="error" /> <human value="If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" /> <expression value="contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" /> <xpath value="not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <key value="dom-5" /> <severity value="error" /> <human value="If a resource is contained in another resource, it SHALL NOT have a security label" /> <expression value="contained.meta.security.empty()" /> <xpath value="not(exists(f:contained/*/f:meta/f:security))" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice"> <valueBoolean value="true" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation"> <valueMarkdown value="When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." /> </extension> <key value="dom-6" /> <severity value="warning" /> <human value="A resource should have narrative for robust management" /> <expression value="text.`div`.exists()" /> <xpath value="exists(f:text/h:div)" /> <source value="http://hl7.org/fhir/StructureDefinition/DomainResource" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="Entity. Role, or Act" /> </mapping> <mapping> <identity value="rim" /> <map value="role" /> </mapping> </element> <element id="RelatedPerson.id"> <path value="RelatedPerson.id" /> <short value="Logical id of this artifact" /> <definition value="The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." /> <comment value="The only time that a resource does not have an id is when it is being submitted to the server using a create operation." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="RelatedPerson.meta"> <path value="RelatedPerson.meta" /> <short value="Metadata about the resource" /> <definition value="The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.meta" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Meta" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> </element> <element id="RelatedPerson.implicitRules"> <path value="RelatedPerson.implicitRules" /> <short value="A set of rules under which this content was created" /> <definition value="A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc." /> <comment value="Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.implicitRules" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="true" /> <isModifierReason value="This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation" /> <isSummary value="true" /> </element> <element id="RelatedPerson.language"> <path value="RelatedPerson.language" /> <short value="Language of the resource content" /> <definition value="The base language in which the resource is written." /> <comment value="Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute)." /> <min value="0" /> <max value="1" /> <base> <path value="Resource.language" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="preferred" /> <description value="A human language." /> <valueSet value="http://hl7.org/fhir/ValueSet/languages" /> </binding> </element> <element id="RelatedPerson.text"> <path value="RelatedPerson.text" /> <short value="Text summary of the resource, for human interpretation" /> <definition value="A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety." /> <comment value="Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later." /> <alias value="narrative" /> <alias value="html" /> <alias value="xhtml" /> <alias value="display" /> <min value="0" /> <max value="1" /> <base> <path value="DomainResource.text" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Narrative" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="Act.text?" /> </mapping> </element> <element id="RelatedPerson.contained"> <path value="RelatedPerson.contained" /> <short value="Contained, inline Resources" /> <definition value="These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope." /> <comment value="This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels." /> <alias value="inline resources" /> <alias value="anonymous resources" /> <alias value="contained resources" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.contained" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Resource" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="RelatedPerson.extension"> <path value="RelatedPerson.extension" /> <short value="Additional content defined by implementations" /> <definition value="May 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." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="RelatedPerson.modifierExtension"> <path value="RelatedPerson.modifierExtension" /> <short value="Extensions that cannot be ignored" /> <definition value="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="DomainResource.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="true" /> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="RelatedPerson.identifier"> <path value="RelatedPerson.identifier" /> <short value="A human identifier for this person" /> <definition value="Identifier for a person within a particular scope." /> <requirements value="People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier." /> <min value="0" /> <max value="*" /> <base> <path value="RelatedPerson.identifier" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Identifier" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="w5" /> <map value="FiveWs.identifier" /> </mapping> <mapping> <identity value="v2" /> <map value="NK1-33" /> </mapping> <mapping> <identity value="rim" /> <map value=".id" /> </mapping> </element> <element id="RelatedPerson.active"> <path value="RelatedPerson.active" /> <short value="Whether this related person's record is in active use" /> <definition value="Whether this related person record is in active use." /> <comment value="This element is labeled as a modifier because it may be used to mark that the resource was created in error." /> <requirements value="Need to be able to mark a related person record as not to be used, such as if it was created in error." /> <min value="0" /> <max value="1" /> <base> <path value="RelatedPerson.active" /> <min value="0" /> <max value="1" /> </base> <type> <code value="boolean" /> </type> <meaningWhenMissing value="This resource is generally assumed to be active if no value is provided for the active element" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="true" /> <isModifierReason value="This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid" /> <isSummary value="true" /> <mapping> <identity value="w5" /> <map value="FiveWs.status" /> </mapping> <mapping> <identity value="rim" /> <map value=".statusCode" /> </mapping> </element> <element id="RelatedPerson.patient"> <path value="RelatedPerson.patient" /> <short value="The patient this person is related to" /> <definition value="The patient this person is related to." /> <requirements value="We need to know which patient this RelatedPerson is related to." /> <min value="1" /> <max value="1" /> <base> <path value="RelatedPerson.patient" /> <min value="1" /> <max value="1" /> </base> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="PID-3" /> </mapping> <mapping> <identity value="rim" /> <map value="scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id" /> </mapping> </element> <element id="RelatedPerson.patient.id"> <path value="RelatedPerson.patient.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="RelatedPerson.patient.extension"> <path value="RelatedPerson.patient.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional content defined by implementations" /> <definition value="May 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." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="RelatedPerson.patient.reference"> <path value="RelatedPerson.patient.reference" /> <short value="Literal reference, Relative, internal or absolute URL" /> <definition value="A 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." /> <comment value="Using 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." /> <min value="1" /> <max value="1" /> <base> <path value="Reference.reference" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <condition value="ref-1" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="RelatedPerson.patient.type"> <path value="RelatedPerson.patient.type" /> <short value="Type the reference refers to (e.g. "Patient")" /> <definition value="The 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.\n\nThe 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)." /> <comment value="This 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." /> <min value="0" /> <max value="1" /> <base> <path value="Reference.type" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="FHIRResourceTypeExt" /> </extension> <strength value="extensible" /> <description value="Aa resource (or, for logical models, the URI of the logical model)." /> <valueSet value="http://hl7.org/fhir/ValueSet/resource-types" /> </binding> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="RelatedPerson.patient.identifier"> <path value="RelatedPerson.patient.identifier" /> <short value="Logical reference, when literal reference is not known" /> <definition value="An 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." /> <comment value="When 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. \n\nWhen 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\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference 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)." /> <min value="0" /> <max value="1" /> <base> <path value="Reference.identifier" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Identifier" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value=".identifier" /> </mapping> </element> <element id="RelatedPerson.patient.display"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true" /> </extension> <path value="RelatedPerson.patient.display" /> <short value="Text alternative for the resource" /> <definition value="Plain text narrative that identifies the resource in addition to the resource reference." /> <comment value="This 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." /> <min value="0" /> <max value="1" /> <base> <path value="Reference.display" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="RelatedPerson.relationship"> <path value="RelatedPerson.relationship" /> <short value="The nature of the relationship" /> <definition value="The nature of the relationship between a patient and the related person." /> <requirements value="We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person." /> <min value="0" /> <max value="*" /> <base> <path value="RelatedPerson.relationship" /> <min value="0" /> <max value="*" /> </base> <type> <code value="CodeableConcept" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="PatientRelationshipType" /> </extension> <strength value="preferred" /> <description value="The nature of the relationship between a patient and the related person." /> <valueSet value="http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype" /> </binding> <mapping> <identity value="w5" /> <map value="FiveWs.class" /> </mapping> <mapping> <identity value="v2" /> <map value="NK1-3" /> </mapping> <mapping> <identity value="rim" /> <map value="code" /> </mapping> </element> <element id="RelatedPerson.relationship.id"> <path value="RelatedPerson.relationship.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="RelatedPerson.relationship.extension"> <path value="RelatedPerson.relationship.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional content defined by implementations" /> <definition value="May 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." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="RelatedPerson.relationship.coding"> <path value="RelatedPerson.relationship.coding" /> <short value="Code defined by a terminology system" /> <definition value="A reference to a code defined by a terminology system." /> <comment value="Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true." /> <requirements value="Allows for alternative encodings within a code system, and translations to other code systems." /> <min value="0" /> <max value="*" /> <base> <path value="CodeableConcept.coding" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Coding" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.1-8, C*E.10-22" /> </mapping> <mapping> <identity value="rim" /> <map value="union(., ./translation)" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" /> </mapping> </element> <element id="RelatedPerson.relationship.coding.id"> <path value="RelatedPerson.relationship.coding.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="RelatedPerson.relationship.coding.extension"> <path value="RelatedPerson.relationship.coding.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional content defined by implementations" /> <definition value="May 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." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="RelatedPerson.relationship.coding.system"> <path value="RelatedPerson.relationship.coding.system" /> <short value="Identity of the terminology system" /> <definition value="The identification of the code system that defines the meaning of the symbol in the code." /> <comment value="The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously." /> <requirements value="Need to be unambiguous about the source of the definition of the symbol." /> <min value="1" /> <max value="1" /> <base> <path value="Coding.system" /> <min value="0" /> <max value="1" /> </base> <type> <code value="uri" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.3" /> </mapping> <mapping> <identity value="rim" /> <map value="./codeSystem" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" /> </mapping> </element> <element id="RelatedPerson.relationship.coding.version"> <path value="RelatedPerson.relationship.coding.version" /> <short value="Version of the system - if relevant" /> <definition value="The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged." /> <comment value="Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date." /> <min value="0" /> <max value="1" /> <base> <path value="Coding.version" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.7" /> </mapping> <mapping> <identity value="rim" /> <map value="./codeSystemVersion" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" /> </mapping> </element> <element id="RelatedPerson.relationship.coding.code"> <path value="RelatedPerson.relationship.coding.code" /> <short value="Symbol in syntax defined by the system" /> <definition value="A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination)." /> <requirements value="Need to refer to a particular code in the system." /> <min value="1" /> <max value="1" /> <base> <path value="Coding.code" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.1" /> </mapping> <mapping> <identity value="rim" /> <map value="./code" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" /> </mapping> </element> <element id="RelatedPerson.relationship.coding.display"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true" /> </extension> <path value="RelatedPerson.relationship.coding.display" /> <short value="Representation defined by the system" /> <definition value="A representation of the meaning of the code in the system, following the rules of the system." /> <requirements value="Need to be able to carry a human-readable meaning of the code for readers that do not know the system." /> <min value="1" /> <max value="1" /> <base> <path value="Coding.display" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.2 - but note this is not well followed" /> </mapping> <mapping> <identity value="rim" /> <map value="CV.displayName" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" /> </mapping> </element> <element id="RelatedPerson.relationship.coding.userSelected"> <path value="RelatedPerson.relationship.coding.userSelected" /> <short value="If this coding was chosen directly by the user" /> <definition value="Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays)." /> <comment value="Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely." /> <requirements value="This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing." /> <min value="0" /> <max value="1" /> <base> <path value="Coding.userSelected" /> <min value="0" /> <max value="1" /> </base> <type> <code value="boolean" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="Sometimes implied by being first" /> </mapping> <mapping> <identity value="rim" /> <map value="CD.codingRationale" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]" /> </mapping> </element> <element id="RelatedPerson.relationship.text"> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable"> <valueBoolean value="true" /> </extension> <path value="RelatedPerson.relationship.text" /> <short value="Plain text representation of the concept" /> <definition value="A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user." /> <comment value="Very often the text is the same as a displayName of one of the codings." /> <requirements value="The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source." /> <min value="0" /> <max value="1" /> <base> <path value="CodeableConcept.text" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="C*E.9. But note many systems use C*E.2 for this" /> </mapping> <mapping> <identity value="rim" /> <map value="./originalText[mediaType/code="text/plain"]/data" /> </mapping> <mapping> <identity value="orim" /> <map value="fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" /> </mapping> </element> <element id="RelatedPerson.name"> <path value="RelatedPerson.name" /> <short value="A name associated with the person" /> <definition value="A name associated with the person." /> <requirements value="Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person." /> <min value="0" /> <max value="*" /> <base> <path value="RelatedPerson.name" /> <min value="0" /> <max value="*" /> </base> <type> <code value="HumanName" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="NK1-2" /> </mapping> <mapping> <identity value="rim" /> <map value="name" /> </mapping> </element> <element id="RelatedPerson.name.id"> <path value="RelatedPerson.name.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="RelatedPerson.name.extension"> <path value="RelatedPerson.name.extension" /> <slicing> <discriminator> <type value="value" /> <path value="url" /> </discriminator> <description value="Extensions are always sliced by (at least) url" /> <rules value="open" /> </slicing> <short value="Additional content defined by implementations" /> <definition value="May 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." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="RelatedPerson.name.use"> <path value="RelatedPerson.name.use" /> <short value="usual | official | temp | nickname | anonymous | old | maiden" /> <definition value="Identifies the purpose for this name." /> <comment value="Applications can assume that a name is current unless it explicitly says that it is temporary or old." /> <requirements value="Allows the appropriate name for a particular context of use to be selected from among a set of names." /> <min value="0" /> <max value="1" /> <base> <path value="HumanName.use" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="true" /> <isModifierReason value="This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="NameUse" /> </extension> <strength value="required" /> <description value="The use of a human name." /> <valueSet value="http://hl7.org/fhir/ValueSet/name-use|4.0.1" /> </binding> <mapping> <identity value="v2" /> <map value="XPN.7, but often indicated by which field contains the name" /> </mapping> <mapping> <identity value="rim" /> <map value="unique(./use)" /> </mapping> <mapping> <identity value="servd" /> <map value="./NamePurpose" /> </mapping> </element> <element id="RelatedPerson.name.text"> <path value="RelatedPerson.name.text" /> <short value="Text representation of the full name" /> <definition value="Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts." /> <comment value="Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part." /> <requirements value="A renderable, unencoded form." /> <min value="0" /> <max value="1" /> <base> <path value="HumanName.text" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="implied by XPN.11" /> </mapping> <mapping> <identity value="rim" /> <map value="./formatted" /> </mapping> </element> <element id="RelatedPerson.name.family"> <path value="RelatedPerson.name.family" /> <short value="Family name (often called 'Surname')" /> <definition value="The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father." /> <comment value="Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures)." /> <alias value="surname" /> <min value="1" /> <max value="1" /> <base> <path value="HumanName.family" /> <min value="0" /> <max value="1" /> </base> <type> <code value="string" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="XPN.1/FN.1" /> </mapping> <mapping> <identity value="rim" /> <map value="./part[partType = FAM]" /> </mapping> <mapping> <identity value="servd" /> <map value="./FamilyName" /> </mapping> </element> <element id="RelatedPerson.name.given"> <path value="RelatedPerson.name.given" /> <short value="Given names (not always 'first'). Includes middle names" /> <definition value="Given name." /> <comment value="If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first." /> <alias value="first name" /> <alias value="middle name" /> <min value="1" /> <max value="*" /> <base> <path value="HumanName.given" /> <min value="0" /> <max value="*" /> </base> <type> <code value="string" /> </type> <orderMeaning value="Given Names appear in the correct order for presenting the name" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="XPN.2 + XPN.3" /> </mapping> <mapping> <identity value="rim" /> <map value="./part[partType = GIV]" /> </mapping> <mapping> <identity value="servd" /> <map value="./GivenNames" /> </mapping> </element> <element id="RelatedPerson.name.prefix"> <path value="RelatedPerson.name.prefix" /> <short value="Parts that come before the name" /> <definition value="Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name." /> <min value="0" /> <max value="*" /> <base> <path value="HumanName.prefix" /> <min value="0" /> <max value="*" /> </base> <type> <code value="string" /> </type> <orderMeaning value="Prefixes appear in the correct order for presenting the name" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="XPN.5" /> </mapping> <mapping> <identity value="rim" /> <map value="./part[partType = PFX]" /> </mapping> <mapping> <identity value="servd" /> <map value="./TitleCode" /> </mapping> </element> <element id="RelatedPerson.name.suffix"> <path value="RelatedPerson.name.suffix" /> <short value="Parts that come after the name" /> <definition value="Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name." /> <min value="0" /> <max value="*" /> <base> <path value="HumanName.suffix" /> <min value="0" /> <max value="*" /> </base> <type> <code value="string" /> </type> <orderMeaning value="Suffixes appear in the correct order for presenting the name" /> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="XPN/4" /> </mapping> <mapping> <identity value="rim" /> <map value="./part[partType = SFX]" /> </mapping> </element> <element id="RelatedPerson.name.period"> <path value="RelatedPerson.name.period" /> <short value="Time period when name was/is in use" /> <definition value="Indicates the period of time when this name was valid for the named person." /> <requirements value="Allows names to be placed in historical context." /> <min value="0" /> <max value="1" /> <base> <path value="HumanName.period" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Period" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="XPN.13 + XPN.14" /> </mapping> <mapping> <identity value="rim" /> <map value="./usablePeriod[type="IVL<TS>"]" /> </mapping> <mapping> <identity value="servd" /> <map value="./StartDate and ./EndDate" /> </mapping> </element> <element id="RelatedPerson.telecom"> <path value="RelatedPerson.telecom" /> <short value="A contact detail for the person" /> <definition value="A contact detail for the person, e.g. a telephone number or an email address." /> <comment value="Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification." /> <requirements value="People have (primary) ways to contact them in some way such as phone, email." /> <min value="0" /> <max value="*" /> <base> <path value="RelatedPerson.telecom" /> <min value="0" /> <max value="*" /> </base> <type> <code value="ContactPoint" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="NK1-5 / NK1-6 / NK1-40" /> </mapping> <mapping> <identity value="rim" /> <map value="telecom" /> </mapping> </element> <element id="RelatedPerson.gender"> <path value="RelatedPerson.gender" /> <short value="male | female | other | unknown" /> <definition value="Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes." /> <requirements value="Needed for identification of the person, in combination with (at least) name and birth date." /> <min value="0" /> <max value="1" /> <base> <path value="RelatedPerson.gender" /> <min value="0" /> <max value="1" /> </base> <type> <code value="code" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="AdministrativeGender" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="required" /> <description value="The gender of a person used for administrative purposes." /> <valueSet value="http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1" /> </binding> <mapping> <identity value="v2" /> <map value="NK1-15" /> </mapping> <mapping> <identity value="rim" /> <map value="administrativeGender" /> </mapping> </element> <element id="RelatedPerson.birthDate"> <path value="RelatedPerson.birthDate" /> <short value="The date on which the related person was born" /> <definition value="The date on which the related person was born." /> <min value="0" /> <max value="1" /> <base> <path value="RelatedPerson.birthDate" /> <min value="0" /> <max value="1" /> </base> <type> <code value="date" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="player.birthTime" /> </mapping> </element> <element id="RelatedPerson.address"> <path value="RelatedPerson.address" /> <short value="Address where the related person can be contacted or visited" /> <definition value="Address where the related person can be contacted or visited." /> <requirements value="Need to keep track where the related person can be contacted per postal mail or visited." /> <min value="0" /> <max value="*" /> <base> <path value="RelatedPerson.address" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Address" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="true" /> <mapping> <identity value="v2" /> <map value="NK1-4" /> </mapping> <mapping> <identity value="rim" /> <map value="addr" /> </mapping> </element> <element id="RelatedPerson.photo"> <path value="RelatedPerson.photo" /> <short value="Image of the person" /> <definition value="Image of the person." /> <requirements value="Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too." /> <min value="0" /> <max value="*" /> <base> <path value="RelatedPerson.photo" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Attachment" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="v2" /> <map value="OBX-5 - needs a profile" /> </mapping> <mapping> <identity value="rim" /> <map value="player[classCode='PSN' and determinerCode='INSTANCE']/desc" /> </mapping> </element> <element id="RelatedPerson.period"> <path value="RelatedPerson.period" /> <short value="Period of time that this relationship is considered valid" /> <definition value="The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown." /> <min value="0" /> <max value="1" /> <base> <path value="RelatedPerson.period" /> <min value="0" /> <max value="1" /> </base> <type> <code value="Period" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="w5" /> <map value="FiveWs.done[x]" /> </mapping> <mapping> <identity value="rim" /> <map value=".effectiveTime" /> </mapping> </element> <element id="RelatedPerson.communication"> <path value="RelatedPerson.communication" /> <short value="A language which may be used to communicate with about the patient's health" /> <definition value="A language which may be used to communicate with about the patient's health." /> <comment value="If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required." /> <requirements value="If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest." /> <min value="0" /> <max value="*" /> <base> <path value="RelatedPerson.communication" /> <min value="0" /> <max value="*" /> </base> <type> <code value="BackboneElement" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="LanguageCommunication" /> </mapping> </element> <element id="RelatedPerson.communication.id"> <path value="RelatedPerson.communication.id" /> <representation value="xmlAttr" /> <short value="Unique id for inter-element referencing" /> <definition value="Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces." /> <min value="0" /> <max value="1" /> <base> <path value="Element.id" /> <min value="0" /> <max value="1" /> </base> <type> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type"> <valueUrl value="string" /> </extension> <code value="http://hl7.org/fhirpath/System.String" /> </type> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="RelatedPerson.communication.extension"> <path value="RelatedPerson.communication.extension" /> <short value="Additional content defined by implementations" /> <definition value="May 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." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <alias value="extensions" /> <alias value="user content" /> <min value="0" /> <max value="*" /> <base> <path value="Element.extension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="n/a" /> </mapping> </element> <element id="RelatedPerson.communication.modifierExtension"> <path value="RelatedPerson.communication.modifierExtension" /> <short value="Extensions that cannot be ignored even if unrecognized" /> <definition value="May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." /> <comment value="There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone." /> <requirements value="Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension)." /> <alias value="extensions" /> <alias value="user content" /> <alias value="modifiers" /> <min value="0" /> <max value="*" /> <base> <path value="BackboneElement.modifierExtension" /> <min value="0" /> <max value="*" /> </base> <type> <code value="Extension" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <constraint> <key value="ext-1" /> <severity value="error" /> <human value="Must have either extensions or value[x], not both" /> <expression value="extension.exists() != value.exists()" /> <xpath value="exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])" /> <source value="http://hl7.org/fhir/StructureDefinition/Extension" /> </constraint> <isModifier value="true" /> <isModifierReason value="Modifier extensions are expected to modify the meaning or interpretation of the element that contains them" /> <isSummary value="true" /> <mapping> <identity value="rim" /> <map value="N/A" /> </mapping> </element> <element id="RelatedPerson.communication.language"> <path value="RelatedPerson.communication.language" /> <short value="The language which can be used to communicate with the patient about his or her health" /> <definition value="The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English." /> <comment value="The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type." /> <requirements value="Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect." /> <min value="1" /> <max value="1" /> <base> <path value="RelatedPerson.communication.language" /> <min value="1" /> <max value="1" /> </base> <type> <code value="CodeableConcept" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <binding> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet"> <valueCanonical value="http://hl7.org/fhir/ValueSet/all-languages" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName"> <valueString value="Language" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding"> <valueBoolean value="true" /> </extension> <strength value="preferred" /> <description value="A human language." /> <valueSet value="http://hl7.org/fhir/ValueSet/languages" /> </binding> <mapping> <identity value="rim" /> <map value="player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code" /> </mapping> </element> <element id="RelatedPerson.communication.preferred"> <path value="RelatedPerson.communication.preferred" /> <short value="Language preference indicator" /> <definition value="Indicates whether or not the patient prefers this language (over other languages he masters up a certain level)." /> <comment value="This language is specifically identified for communicating healthcare information." /> <requirements value="People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method." /> <min value="0" /> <max value="1" /> <base> <path value="RelatedPerson.communication.preferred" /> <min value="0" /> <max value="1" /> </base> <type> <code value="boolean" /> </type> <constraint> <key value="ele-1" /> <severity value="error" /> <human value="All FHIR elements must have a @value or children" /> <expression value="hasValue() or (children().count() > id.count())" /> <xpath value="@value|f:*|h:div" /> <source value="http://hl7.org/fhir/StructureDefinition/Element" /> </constraint> <isModifier value="false" /> <isSummary value="false" /> <mapping> <identity value="rim" /> <map value="preferenceInd" /> </mapping> </element> </snapshot> <differential> <element id="RelatedPerson.patient.reference"> <path value="RelatedPerson.patient.reference" /> <min value="1" /> </element> <element id="RelatedPerson.relationship.coding.system"> <path value="RelatedPerson.relationship.coding.system" /> <min value="1" /> </element> <element id="RelatedPerson.relationship.coding.code"> <path value="RelatedPerson.relationship.coding.code" /> <min value="1" /> </element> <element id="RelatedPerson.relationship.coding.display"> <path value="RelatedPerson.relationship.coding.display" /> <min value="1" /> </element> <element id="RelatedPerson.name.family"> <path value="RelatedPerson.name.family" /> <min value="1" /> </element> <element id="RelatedPerson.name.given"> <path value="RelatedPerson.name.given" /> <min value="1" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "relatedperson-ca-core", "url": "http://fhir.infoway-inforoute.ca/cacore/StructureDefinition/relatedperson-ca-core", "name": "RelatedPersonCACore", "title": "RelatedPerson (CA-Core)", "status": "draft", "experimental": false, "date": "2025-03-31", "publisher": "Canada Health Infoway", "contact": [ { "name": "National Standards Release Centre", "telecom": [ { "system": "url", "value": "http://www.infoway-inforoute.ca" }, { "system": "email", "value": "standards@infoway-inforoute.ca" } ] } ], "description": "This profile represents the constraints applied to the RelatedPerson resource by the CA Core+ project to represent the minimum expectations for the RelatedPerson resource when used to promote capacity building for functionality found across Canadian FHIR implementations. It is informed by the constraints of shared across CIHI pCHDCF data sets.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "CA" } ] } ], "copyright": "Copyright © 2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "RelatedPerson", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "derivation": "constraint", "snapshot": { "element": [ { "id": "RelatedPerson", "path": "RelatedPerson", "short": "A person that is related to a patient, but who is not a direct target of care", "definition": "Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.", "min": 0, "max": "*", "base": { "path": "RelatedPerson", "min": 0, "max": "*" }, "constraint": [ { "key": "dom-2", "severity": "error", "human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources", "expression": "contained.contained.empty()", "xpath": "not(parent::f:contained and f:contained)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-3", "severity": "error", "human": "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", "expression": "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()", "xpath": "not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-4", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated", "expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "key": "dom-5", "severity": "error", "human": "If a resource is contained in another resource, it SHALL NOT have a security label", "expression": "contained.meta.security.empty()", "xpath": "not(exists(f:contained/*/f:meta/f:security))", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice", "valueBoolean": true }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation", "valueMarkdown": "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." } ], "key": "dom-6", "severity": "warning", "human": "A resource should have narrative for robust management", "expression": "text.`div`.exists()", "xpath": "exists(f:text/h:div)", "source": "http://hl7.org/fhir/StructureDefinition/DomainResource" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Entity. Role, or Act" }, { "identity": "rim", "map": "role" } ] }, { "id": "RelatedPerson.id", "path": "RelatedPerson.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.", "min": 0, "max": "1", "base": { "path": "Resource.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": true }, { "id": "RelatedPerson.meta", "path": "RelatedPerson.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Resource.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true }, { "id": "RelatedPerson.implicitRules", "path": "RelatedPerson.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.", "comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.", "min": 0, "max": "1", "base": { "path": "Resource.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation", "isSummary": true }, { "id": "RelatedPerson.language", "path": "RelatedPerson.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": { "path": "Resource.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages" } }, { "id": "RelatedPerson.text", "path": "RelatedPerson.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "DomainResource.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "id": "RelatedPerson.contained", "path": "RelatedPerson.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "DomainResource.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "RelatedPerson.extension", "path": "RelatedPerson.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "RelatedPerson.modifierExtension", "path": "RelatedPerson.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "DomainResource.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them", "isSummary": false, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "RelatedPerson.identifier", "path": "RelatedPerson.identifier", "short": "A human identifier for this person", "definition": "Identifier for a person within a particular scope.", "requirements": "People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.", "min": 0, "max": "*", "base": { "path": "RelatedPerson.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.identifier" }, { "identity": "v2", "map": "NK1-33" }, { "identity": "rim", "map": ".id" } ] }, { "id": "RelatedPerson.active", "path": "RelatedPerson.active", "short": "Whether this related person's record is in active use", "definition": "Whether this related person record is in active use.", "comment": "This element is labeled as a modifier because it may be used to mark that the resource was created in error.", "requirements": "Need to be able to mark a related person record as not to be used, such as if it was created in error.", "min": 0, "max": "1", "base": { "path": "RelatedPerson.active", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "meaningWhenMissing": "This resource is generally assumed to be active if no value is provided for the active element", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This element is labelled as a modifier because it is a status element that can indicate that a record should not be treated as valid", "isSummary": true, "mapping": [ { "identity": "w5", "map": "FiveWs.status" }, { "identity": "rim", "map": ".statusCode" } ] }, { "id": "RelatedPerson.patient", "path": "RelatedPerson.patient", "short": "The patient this person is related to", "definition": "The patient this person is related to.", "requirements": "We need to know which patient this RelatedPerson is related to.", "min": 1, "max": "1", "base": { "path": "RelatedPerson.patient", "min": 1, "max": "1" }, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient" ] } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "PID-3" }, { "identity": "rim", "map": "scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id" } ] }, { "id": "RelatedPerson.patient.id", "path": "RelatedPerson.patient.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedPerson.patient.extension", "path": "RelatedPerson.patient.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedPerson.patient.reference", "path": "RelatedPerson.patient.reference", "short": "Literal reference, Relative, internal or absolute URL", "definition": "A 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.", "comment": "Using 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.", "min": 1, "max": "1", "base": { "path": "Reference.reference", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "condition": [ "ref-1" ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "RelatedPerson.patient.type", "path": "RelatedPerson.patient.type", "short": "Type the reference refers to (e.g. \"Patient\")", "definition": "The 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.\n\nThe 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).", "comment": "This 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.", "min": 0, "max": "1", "base": { "path": "Reference.type", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "FHIRResourceTypeExt" } ], "strength": "extensible", "description": "Aa resource (or, for logical models, the URI of the logical model).", "valueSet": "http://hl7.org/fhir/ValueSet/resource-types" }, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "RelatedPerson.patient.identifier", "path": "RelatedPerson.patient.identifier", "short": "Logical reference, when literal reference is not known", "definition": "An 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.", "comment": "When 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. \n\nWhen 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\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.\n\nReference 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).", "min": 0, "max": "1", "base": { "path": "Reference.identifier", "min": 0, "max": "1" }, "type": [ { "code": "Identifier" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".identifier" } ] }, { "id": "RelatedPerson.patient.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "RelatedPerson.patient.display", "short": "Text alternative for the resource", "definition": "Plain text narrative that identifies the resource in addition to the resource reference.", "comment": "This 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.", "min": 0, "max": "1", "base": { "path": "Reference.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "RelatedPerson.relationship", "path": "RelatedPerson.relationship", "short": "The nature of the relationship", "definition": "The nature of the relationship between a patient and the related person.", "requirements": "We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.", "min": 0, "max": "*", "base": { "path": "RelatedPerson.relationship", "min": 0, "max": "*" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "PatientRelationshipType" } ], "strength": "preferred", "description": "The nature of the relationship between a patient and the related person.", "valueSet": "http://hl7.org/fhir/ValueSet/relatedperson-relationshiptype" }, "mapping": [ { "identity": "w5", "map": "FiveWs.class" }, { "identity": "v2", "map": "NK1-3" }, { "identity": "rim", "map": "code" } ] }, { "id": "RelatedPerson.relationship.id", "path": "RelatedPerson.relationship.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedPerson.relationship.extension", "path": "RelatedPerson.relationship.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedPerson.relationship.coding", "path": "RelatedPerson.relationship.coding", "short": "Code defined by a terminology system", "definition": "A reference to a code defined by a terminology system.", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.", "requirements": "Allows for alternative encodings within a code system, and translations to other code systems.", "min": 0, "max": "*", "base": { "path": "CodeableConcept.coding", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1-8, C*E.10-22" }, { "identity": "rim", "map": "union(., ./translation)" }, { "identity": "orim", "map": "fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding" } ] }, { "id": "RelatedPerson.relationship.coding.id", "path": "RelatedPerson.relationship.coding.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedPerson.relationship.coding.extension", "path": "RelatedPerson.relationship.coding.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedPerson.relationship.coding.system", "path": "RelatedPerson.relationship.coding.system", "short": "Identity of the terminology system", "definition": "The identification of the code system that defines the meaning of the symbol in the code.", "comment": "The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.", "requirements": "Need to be unambiguous about the source of the definition of the symbol.", "min": 1, "max": "1", "base": { "path": "Coding.system", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.3" }, { "identity": "rim", "map": "./codeSystem" }, { "identity": "orim", "map": "fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem" } ] }, { "id": "RelatedPerson.relationship.coding.version", "path": "RelatedPerson.relationship.coding.version", "short": "Version of the system - if relevant", "definition": "The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.", "comment": "Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.", "min": 0, "max": "1", "base": { "path": "Coding.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.7" }, { "identity": "rim", "map": "./codeSystemVersion" }, { "identity": "orim", "map": "fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion" } ] }, { "id": "RelatedPerson.relationship.coding.code", "path": "RelatedPerson.relationship.coding.code", "short": "Symbol in syntax defined by the system", "definition": "A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).", "requirements": "Need to refer to a particular code in the system.", "min": 1, "max": "1", "base": { "path": "Coding.code", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.1" }, { "identity": "rim", "map": "./code" }, { "identity": "orim", "map": "fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code" } ] }, { "id": "RelatedPerson.relationship.coding.display", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "RelatedPerson.relationship.coding.display", "short": "Representation defined by the system", "definition": "A representation of the meaning of the code in the system, following the rules of the system.", "requirements": "Need to be able to carry a human-readable meaning of the code for readers that do not know the system.", "min": 1, "max": "1", "base": { "path": "Coding.display", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.2 - but note this is not well followed" }, { "identity": "rim", "map": "CV.displayName" }, { "identity": "orim", "map": "fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName" } ] }, { "id": "RelatedPerson.relationship.coding.userSelected", "path": "RelatedPerson.relationship.coding.userSelected", "short": "If this coding was chosen directly by the user", "definition": "Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).", "comment": "Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.", "requirements": "This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.", "min": 0, "max": "1", "base": { "path": "Coding.userSelected", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "Sometimes implied by being first" }, { "identity": "rim", "map": "CD.codingRationale" }, { "identity": "orim", "map": "fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\\#true a [ fhir:source \"true\"; fhir:target dt:CDCoding.codingRationale\\#O ]" } ] }, { "id": "RelatedPerson.relationship.text", "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable", "valueBoolean": true } ], "path": "RelatedPerson.relationship.text", "short": "Plain text representation of the concept", "definition": "A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.", "comment": "Very often the text is the same as a displayName of one of the codings.", "requirements": "The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.", "min": 0, "max": "1", "base": { "path": "CodeableConcept.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "C*E.9. But note many systems use C*E.2 for this" }, { "identity": "rim", "map": "./originalText[mediaType/code=\"text/plain\"]/data" }, { "identity": "orim", "map": "fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText" } ] }, { "id": "RelatedPerson.name", "path": "RelatedPerson.name", "short": "A name associated with the person", "definition": "A name associated with the person.", "requirements": "Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.", "min": 0, "max": "*", "base": { "path": "RelatedPerson.name", "min": 0, "max": "*" }, "type": [ { "code": "HumanName" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "NK1-2" }, { "identity": "rim", "map": "name" } ] }, { "id": "RelatedPerson.name.id", "path": "RelatedPerson.name.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedPerson.name.extension", "path": "RelatedPerson.name.extension", "slicing": { "discriminator": [ { "type": "value", "path": "url" } ], "description": "Extensions are always sliced by (at least) url", "rules": "open" }, "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedPerson.name.use", "path": "RelatedPerson.name.use", "short": "usual | official | temp | nickname | anonymous | old | maiden", "definition": "Identifies the purpose for this name.", "comment": "Applications can assume that a name is current unless it explicitly says that it is temporary or old.", "requirements": "Allows the appropriate name for a particular context of use to be selected from among a set of names.", "min": 0, "max": "1", "base": { "path": "HumanName.use", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": true, "isModifierReason": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary or old name etc.for a current/permanent one", "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "NameUse" } ], "strength": "required", "description": "The use of a human name.", "valueSet": "http://hl7.org/fhir/ValueSet/name-use|4.0.1" }, "mapping": [ { "identity": "v2", "map": "XPN.7, but often indicated by which field contains the name" }, { "identity": "rim", "map": "unique(./use)" }, { "identity": "servd", "map": "./NamePurpose" } ] }, { "id": "RelatedPerson.name.text", "path": "RelatedPerson.name.text", "short": "Text representation of the full name", "definition": "Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts.", "comment": "Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part.", "requirements": "A renderable, unencoded form.", "min": 0, "max": "1", "base": { "path": "HumanName.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "implied by XPN.11" }, { "identity": "rim", "map": "./formatted" } ] }, { "id": "RelatedPerson.name.family", "path": "RelatedPerson.name.family", "short": "Family name (often called 'Surname')", "definition": "The part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father.", "comment": "Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).", "alias": [ "surname" ], "min": 1, "max": "1", "base": { "path": "HumanName.family", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.1/FN.1" }, { "identity": "rim", "map": "./part[partType = FAM]" }, { "identity": "servd", "map": "./FamilyName" } ] }, { "id": "RelatedPerson.name.given", "path": "RelatedPerson.name.given", "short": "Given names (not always 'first'). Includes middle names", "definition": "Given name.", "comment": "If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called \"first name\" since given names do not always come first.", "alias": [ "first name", "middle name" ], "min": 1, "max": "*", "base": { "path": "HumanName.given", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "orderMeaning": "Given Names appear in the correct order for presenting the name", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.2 + XPN.3" }, { "identity": "rim", "map": "./part[partType = GIV]" }, { "identity": "servd", "map": "./GivenNames" } ] }, { "id": "RelatedPerson.name.prefix", "path": "RelatedPerson.name.prefix", "short": "Parts that come before the name", "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.", "min": 0, "max": "*", "base": { "path": "HumanName.prefix", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "orderMeaning": "Prefixes appear in the correct order for presenting the name", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.5" }, { "identity": "rim", "map": "./part[partType = PFX]" }, { "identity": "servd", "map": "./TitleCode" } ] }, { "id": "RelatedPerson.name.suffix", "path": "RelatedPerson.name.suffix", "short": "Parts that come after the name", "definition": "Part of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.", "min": 0, "max": "*", "base": { "path": "HumanName.suffix", "min": 0, "max": "*" }, "type": [ { "code": "string" } ], "orderMeaning": "Suffixes appear in the correct order for presenting the name", "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN/4" }, { "identity": "rim", "map": "./part[partType = SFX]" } ] }, { "id": "RelatedPerson.name.period", "path": "RelatedPerson.name.period", "short": "Time period when name was/is in use", "definition": "Indicates the period of time when this name was valid for the named person.", "requirements": "Allows names to be placed in historical context.", "min": 0, "max": "1", "base": { "path": "HumanName.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "XPN.13 + XPN.14" }, { "identity": "rim", "map": "./usablePeriod[type=\"IVL<TS>\"]" }, { "identity": "servd", "map": "./StartDate and ./EndDate" } ] }, { "id": "RelatedPerson.telecom", "path": "RelatedPerson.telecom", "short": "A contact detail for the person", "definition": "A contact detail for the person, e.g. a telephone number or an email address.", "comment": "Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification.", "requirements": "People have (primary) ways to contact them in some way such as phone, email.", "min": 0, "max": "*", "base": { "path": "RelatedPerson.telecom", "min": 0, "max": "*" }, "type": [ { "code": "ContactPoint" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "NK1-5 / NK1-6 / NK1-40" }, { "identity": "rim", "map": "telecom" } ] }, { "id": "RelatedPerson.gender", "path": "RelatedPerson.gender", "short": "male | female | other | unknown", "definition": "Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes.", "requirements": "Needed for identification of the person, in combination with (at least) name and birth date.", "min": 0, "max": "1", "base": { "path": "RelatedPerson.gender", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "AdministrativeGender" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "required", "description": "The gender of a person used for administrative purposes.", "valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender|4.0.1" }, "mapping": [ { "identity": "v2", "map": "NK1-15" }, { "identity": "rim", "map": "administrativeGender" } ] }, { "id": "RelatedPerson.birthDate", "path": "RelatedPerson.birthDate", "short": "The date on which the related person was born", "definition": "The date on which the related person was born.", "min": 0, "max": "1", "base": { "path": "RelatedPerson.birthDate", "min": 0, "max": "1" }, "type": [ { "code": "date" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "rim", "map": "player.birthTime" } ] }, { "id": "RelatedPerson.address", "path": "RelatedPerson.address", "short": "Address where the related person can be contacted or visited", "definition": "Address where the related person can be contacted or visited.", "requirements": "Need to keep track where the related person can be contacted per postal mail or visited.", "min": 0, "max": "*", "base": { "path": "RelatedPerson.address", "min": 0, "max": "*" }, "type": [ { "code": "Address" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": true, "mapping": [ { "identity": "v2", "map": "NK1-4" }, { "identity": "rim", "map": "addr" } ] }, { "id": "RelatedPerson.photo", "path": "RelatedPerson.photo", "short": "Image of the person", "definition": "Image of the person.", "requirements": "Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.", "min": 0, "max": "*", "base": { "path": "RelatedPerson.photo", "min": 0, "max": "*" }, "type": [ { "code": "Attachment" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "v2", "map": "OBX-5 - needs a profile" }, { "identity": "rim", "map": "player[classCode='PSN' and determinerCode='INSTANCE']/desc" } ] }, { "id": "RelatedPerson.period", "path": "RelatedPerson.period", "short": "Period of time that this relationship is considered valid", "definition": "The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.", "min": 0, "max": "1", "base": { "path": "RelatedPerson.period", "min": 0, "max": "1" }, "type": [ { "code": "Period" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "w5", "map": "FiveWs.done[x]" }, { "identity": "rim", "map": ".effectiveTime" } ] }, { "id": "RelatedPerson.communication", "path": "RelatedPerson.communication", "short": "A language which may be used to communicate with about the patient's health", "definition": "A language which may be used to communicate with about the patient's health.", "comment": "If no language is specified, this *implies* that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required.", "requirements": "If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest.", "min": 0, "max": "*", "base": { "path": "RelatedPerson.communication", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "LanguageCommunication" } ] }, { "id": "RelatedPerson.communication.id", "path": "RelatedPerson.communication.id", "representation": [ "xmlAttr" ], "short": "Unique id for inter-element referencing", "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.", "min": 0, "max": "1", "base": { "path": "Element.id", "min": 0, "max": "1" }, "type": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type", "valueUrl": "string" } ], "code": "http://hl7.org/fhirpath/System.String" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedPerson.communication.extension", "path": "RelatedPerson.communication.extension", "short": "Additional content defined by implementations", "definition": "May be used to represent additional information that is not part of the basic definition of the element. 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.", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Element.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "RelatedPerson.communication.modifierExtension", "path": "RelatedPerson.communication.modifierExtension", "short": "Extensions that cannot be ignored even if unrecognized", "definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).", "comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](extensibility.html#modifierExtension).", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "BackboneElement.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" }, { "key": "ext-1", "severity": "error", "human": "Must have either extensions or value[x], not both", "expression": "extension.exists() != value.exists()", "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])", "source": "http://hl7.org/fhir/StructureDefinition/Extension" } ], "isModifier": true, "isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them", "isSummary": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "id": "RelatedPerson.communication.language", "path": "RelatedPerson.communication.language", "short": "The language which can be used to communicate with the patient about his or her health", "definition": "The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. \"en\" for English, or \"en-US\" for American English versus \"en-EN\" for England English.", "comment": "The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type.", "requirements": "Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect.", "min": 1, "max": "1", "base": { "path": "RelatedPerson.communication.language", "min": 1, "max": "1" }, "type": [ { "code": "CodeableConcept" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "binding": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet", "valueCanonical": "http://hl7.org/fhir/ValueSet/all-languages" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName", "valueString": "Language" }, { "url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding", "valueBoolean": true } ], "strength": "preferred", "description": "A human language.", "valueSet": "http://hl7.org/fhir/ValueSet/languages" }, "mapping": [ { "identity": "rim", "map": "player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code" } ] }, { "id": "RelatedPerson.communication.preferred", "path": "RelatedPerson.communication.preferred", "short": "Language preference indicator", "definition": "Indicates whether or not the patient prefers this language (over other languages he masters up a certain level).", "comment": "This language is specifically identified for communicating healthcare information.", "requirements": "People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method.", "min": 0, "max": "1", "base": { "path": "RelatedPerson.communication.preferred", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "constraint": [ { "key": "ele-1", "severity": "error", "human": "All FHIR elements must have a @value or children", "expression": "hasValue() or (children().count() > id.count())", "xpath": "@value|f:*|h:div", "source": "http://hl7.org/fhir/StructureDefinition/Element" } ], "isModifier": false, "isSummary": false, "mapping": [ { "identity": "rim", "map": "preferenceInd" } ] } ] }, "differential": { "element": [ { "id": "RelatedPerson.patient.reference", "path": "RelatedPerson.patient.reference", "min": 1 }, { "id": "RelatedPerson.relationship.coding.system", "path": "RelatedPerson.relationship.coding.system", "min": 1 }, { "id": "RelatedPerson.relationship.coding.code", "path": "RelatedPerson.relationship.coding.code", "min": 1 }, { "id": "RelatedPerson.relationship.coding.display", "path": "RelatedPerson.relationship.coding.display", "min": 1 }, { "id": "RelatedPerson.name.family", "path": "RelatedPerson.name.family", "min": 1 }, { "id": "RelatedPerson.name.given", "path": "RelatedPerson.name.given", "min": 1 } ] } }