CH EMR (R4)
1.0.0-ballot - ballot
CH EMR (R4)
1.0.0-ballot - ballot
CH EMR (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-emr/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-emr/StructureDefinition/ch-emr-relatedperson | Version: 1.0.0-ballot | ||||
| Active as of 2026-10-23 | Computable Name: ChEmrRelatedPerson | ||||
Copyright/Legal: CC0-1.0 |
|||||
RelatedPerson profile for emergency contacts and family members in the Emergency Record.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:  | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  RelatedPerson |
0..* | CHCoreRelatedPerson(7.0.0-ballot) | CH Core RelatedPerson | |||||||||
  implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||
  Slices for extension |
Content/Rules for all slices | |||||||||||
   extension:citizenship |
0..* | (Complex) | Citizenship(s) of related person URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship | |||||||||
 modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||
| active |
0..1 | boolean | Whether this related person's record is in active use | |||||||||
 patient |
1..1 | Reference(CH IPS Patient) {b} | The patient this person is related to | |||||||||
 relationship |
0..* | CodeableConcept | The nature of the relationship Binding: PersonalRelationshipRoleType (preferred)
| |||||||||
| name |
1..* | CHCoreHumanName(7.0.0-ballot)  |
A name associated with the person
| |||||||||
| Slices for telecom |
0..* | ContactPoint | A contact detail for the person Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
 telecom:email |
0..* | CHCoreContactPointECH46Email(7.0.0-ballot) |
A contact detail for the person
| |||||||||
  system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email (no extensions allowed) | ||||||||
| value |
1..1 | string | The actual contact point details | |||||||||
 use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
  Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:emailCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory Binding: eCH-0046 Email Category (extensible) | |||||||||
| telecom:phone |
0..* | CHCoreContactPointECH46Phone(7.0.0-ballot) |
A contact detail for the person
| |||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone (no extensions allowed) | ||||||||
| value |
1..1 | string | The actual contact point details | |||||||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:phoneCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory Binding: eCH-0046 Phone Category (extensible) | |||||||||
 telecom:internet |
0..* | CHCoreContactPointECH46Internet(7.0.0-ballot) |
A contact detail for the person | |||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url (no extensions allowed) | ||||||||
| value |
1..1 | string | The actual contact point details | |||||||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:internetCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-internetcategory Binding: eCH-0046 Internet Category (extensible) | |||||||||
| address |
0..* | CHCoreAddress(7.0.0-ballot) |
Address where the related person can be contacted or visited
| |||||||||
| communication |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
 language |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred)
| |||||||||
| Documentation for this format | ||||||||||||
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| RelatedPerson |
||
| Slices for extension |
||
| relationship |
|
|
| name |
|
|
| Slices for telecom |
||
 telecom:email |
|
|
| telecom:phone |
|
|
| address |
|
|
| communication |
||
| language |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.relationship | Base | preferred | PersonalRelationshipRoleType | 📦3.0.0 | THO v7.1 |
| RelatedPerson.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:internet.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:internet.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from CHCoreRelatedPerson
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| RelatedPerson |
||
 relationship |
|
|
| name |
|
|
| Slices for telecom |
||
| telecom:email |
|
|
| telecom:phone |
|
|
| address |
|
|
| communication |
||
| language |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.relationship | Base | preferred | PersonalRelationshipRoleType | 📦3.0.0 | THO v7.1 |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | CHCoreRelatedPerson(7.0.0-ballot) | CH Core RelatedPerson | |||||||||
| id |
0..1 | id | Logical id of this artifact | |||||||||
| meta |
0..1 | Meta | Metadata about the resource | |||||||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| extension:citizenship |
0..* | (Complex) | Citizenship(s) of related person URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||
| identifier |
0..* | Identifier | A human identifier for this person | |||||||||
| active |
0..1 | boolean | Whether this related person's record is in active use | |||||||||
| patient |
1..1 | Reference(CH IPS Patient) {b} | The patient this person is related to | |||||||||
| relationship |
0..* | CodeableConcept | The nature of the relationship Binding: PersonalRelationshipRoleType (preferred)
| |||||||||
| name |
1..* | CHCoreHumanName(7.0.0-ballot) |
A name associated with the person
| |||||||||
| Slices for telecom |
0..* | ContactPoint | A contact detail for the person Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| telecom:email |
0..* | CHCoreContactPointECH46Email(7.0.0-ballot) |
A contact detail for the person
| |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email (no extensions allowed) | ||||||||
| value |
1..1 | string | The actual contact point details | |||||||||
 use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
 id |
0..1 | string | xml:id (or equivalent in JSON) | |||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:emailCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory Binding: eCH-0046 Email Category (extensible) | |||||||||
| value |
0..1 | string | Primitive value for code | |||||||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| start |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||||||
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| telecom:phone |
0..* | CHCoreContactPointECH46Phone(7.0.0-ballot) |
A contact detail for the person
| |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone (no extensions allowed) | ||||||||
| value |
1..1 | string | The actual contact point details | |||||||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:phoneCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory Binding: eCH-0046 Phone Category (extensible) | |||||||||
| value |
0..1 | string | Primitive value for code | |||||||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| start |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||||||
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| telecom:internet |
0..* | CHCoreContactPointECH46Internet(7.0.0-ballot) |
A contact detail for the person | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url (no extensions allowed) | ||||||||
| value |
1..1 | string | The actual contact point details | |||||||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:internetCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-internetcategory Binding: eCH-0046 Internet Category (extensible) | |||||||||
| value |
0..1 | string | Primitive value for code | |||||||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| start |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||||||
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| gender |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||||
| birthDate |
0..1 | date | The date on which the related person was born | |||||||||
| address |
0..* | CHCoreAddress(7.0.0-ballot) |
Address where the related person can be contacted or visited
| |||||||||
| photo |
0..* | Attachment | Image of the person | |||||||||
| period |
0..1 | Period | Period of time that this relationship is considered valid | |||||||||
| communication |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| language |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred)
| |||||||||
| preferred |
0..1 | boolean | Language preference indicator | |||||||||
| Documentation for this format | ||||||||||||
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| RelatedPerson |
||
| Slices for extension |
||
| relationship |
|
|
| name |
|
|
| Slices for telecom |
||
| telecom:email |
|
|
| telecom:phone |
|
|
| address |
|
|
| communication |
||
| language |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | PersonalRelationshipRoleType | 📦3.0.0 | THO v7.1 |
| RelatedPerson.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:internet.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:internet.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| RelatedPerson |
||
| Slices for extension |
||
| relationship |
|
|
| name |
|
|
| Slices for telecom |
||
| telecom:email |
|
|
| telecom:phone |
|
|
| address |
|
|
| communication |
||
| language |
|
|
| Documentation for this format | ||
This structure is derived from CHCoreRelatedPerson
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | CHCoreRelatedPerson(7.0.0-ballot) | CH Core RelatedPerson | |||||||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:citizenship |
0..* | (Complex) | Citizenship(s) of related person URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||
| active |
0..1 | boolean | Whether this related person's record is in active use | |||||||||
| patient |
1..1 | Reference(CH IPS Patient) {b} | The patient this person is related to | |||||||||
| relationship |
0..* | CodeableConcept | The nature of the relationship Binding: PersonalRelationshipRoleType (preferred)
| |||||||||
| name |
1..* | CHCoreHumanName(7.0.0-ballot) |
A name associated with the person
| |||||||||
| Slices for telecom |
0..* | ContactPoint | A contact detail for the person Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| telecom:email |
0..* | CHCoreContactPointECH46Email(7.0.0-ballot) |
A contact detail for the person
| |||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email (no extensions allowed) | ||||||||
| value |
1..1 | string | The actual contact point details | |||||||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:emailCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory Binding: eCH-0046 Email Category (extensible) | |||||||||
| telecom:phone |
0..* | CHCoreContactPointECH46Phone(7.0.0-ballot) |
A contact detail for the person
| |||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone (no extensions allowed) | ||||||||
| value |
1..1 | string | The actual contact point details | |||||||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:phoneCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory Binding: eCH-0046 Phone Category (extensible) | |||||||||
| telecom:internet |
0..* | CHCoreContactPointECH46Internet(7.0.0-ballot) |
A contact detail for the person | |||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url (no extensions allowed) | ||||||||
| value |
1..1 | string | The actual contact point details | |||||||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:internetCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-internetcategory Binding: eCH-0046 Internet Category (extensible) | |||||||||
| address |
0..* | CHCoreAddress(7.0.0-ballot) |
Address where the related person can be contacted or visited
| |||||||||
| communication |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| language |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred)
| |||||||||
| Documentation for this format | ||||||||||||
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| RelatedPerson |
||
| Slices for extension |
||
| relationship |
|
|
| name |
|
|
| Slices for telecom |
||
| telecom:email |
|
|
| telecom:phone |
|
|
| address |
|
|
| communication |
||
| language |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.relationship | Base | preferred | PersonalRelationshipRoleType | 📦3.0.0 | THO v7.1 |
| RelatedPerson.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:internet.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:internet.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from CHCoreRelatedPerson
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
CHCoreRelatedPerson(7.0.0-ballot) | |||||||||||
| patient |
1..1 | Reference(CH IPS Patient) {b} | The patient this person is related to | |||||||||
| relationship |
0..* | CodeableConcept | The nature of the relationship Binding: PersonalRelationshipRoleType (preferred)
| |||||||||
| name |
1..* | CHCoreHumanName(7.0.0-ballot) | A name associated with the person
| |||||||||
| Slices for telecom |
Content/Rules for all slices | |||||||||||
| telecom:email |
0..* | CHCoreContactPointECH46Email(7.0.0-ballot) | A contact detail for the person
| |||||||||
| telecom:phone |
0..* | CHCoreContactPointECH46Phone(7.0.0-ballot) | A contact detail for the person
| |||||||||
| address |
0..* | CHCoreAddress(7.0.0-ballot) | Address where the related person can be contacted or visited
| |||||||||
| communication |
||||||||||||
| language |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred)
| |||||||||
| Documentation for this format | ||||||||||||
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| RelatedPerson |
||
| relationship |
|
|
| name |
|
|
| Slices for telecom |
||
| telecom:email |
|
|
| telecom:phone |
|
|
| address |
|
|
| communication |
||
| language |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.relationship | Base | preferred | PersonalRelationshipRoleType | 📦3.0.0 | THO v7.1 |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| RelatedPerson |
0..* | CHCoreRelatedPerson(7.0.0-ballot) | CH Core RelatedPerson | |||||||||
| id |
0..1 | id | Logical id of this artifact | |||||||||
| meta |
0..1 | Meta | Metadata about the resource | |||||||||
| implicitRules |
0..1 | uri | A set of rules under which this content was created | |||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||
| text |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| extension:citizenship |
0..* | (Complex) | Citizenship(s) of related person URL: http://hl7.org/fhir/StructureDefinition/patient-citizenship | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored | |||||||||
| identifier |
0..* | Identifier | A human identifier for this person | |||||||||
| active |
0..1 | boolean | Whether this related person's record is in active use | |||||||||
| patient |
1..1 | Reference(CH IPS Patient) {b} | The patient this person is related to | |||||||||
| relationship |
0..* | CodeableConcept | The nature of the relationship Binding: PersonalRelationshipRoleType (preferred)
| |||||||||
| name |
1..* | CHCoreHumanName(7.0.0-ballot) |
A name associated with the person
| |||||||||
| Slices for telecom |
0..* | ContactPoint | A contact detail for the person Slice: Unordered, Open by value:system Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||||||
| telecom:email |
0..* | CHCoreContactPointECH46Email(7.0.0-ballot) |
A contact detail for the person
| |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: email (no extensions allowed) | ||||||||
| value |
1..1 | string | The actual contact point details | |||||||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:emailCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-emailcategory Binding: eCH-0046 Email Category (extensible) | |||||||||
| value |
0..1 | string | Primitive value for code | |||||||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| start |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||||||
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| telecom:phone |
0..* | CHCoreContactPointECH46Phone(7.0.0-ballot) |
A contact detail for the person
| |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: phone (no extensions allowed) | ||||||||
| value |
1..1 | string | The actual contact point details | |||||||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:phoneCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-phonecategory Binding: eCH-0046 Phone Category (extensible) | |||||||||
| value |
0..1 | string | Primitive value for code | |||||||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| start |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||||||
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| telecom:internet |
0..* | CHCoreContactPointECH46Internet(7.0.0-ballot) |
A contact detail for the person | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| system |
C | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. Fixed Value: url (no extensions allowed) | ||||||||
| value |
1..1 | string | The actual contact point details | |||||||||
| use |
0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required): Use of contact point. | |||||||||
| id |
0..1 | string | xml:id (or equivalent in JSON) | |||||||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||
| Slices for extension |
Content/Rules for all slices | |||||||||||
| extension:internetCategory |
0..1 | CodeableConcept | Optional Extensions Element URL: http://fhir.ch/ig/ch-core/StructureDefinition/ch-ext-ech-46-internetcategory Binding: eCH-0046 Internet Category (extensible) | |||||||||
| value |
0..1 | string | Primitive value for code | |||||||||
| rank |
0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||
| period |
0..1 | Period | Time period when the contact point was/is in use | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||
| start |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||||||
| end |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||||||
| gender |
0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||||
| birthDate |
0..1 | date | The date on which the related person was born | |||||||||
| address |
0..* | CHCoreAddress(7.0.0-ballot) |
Address where the related person can be contacted or visited
| |||||||||
| photo |
0..* | Attachment | Image of the person | |||||||||
| period |
0..1 | Period | Period of time that this relationship is considered valid | |||||||||
| communication |
0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||||||
| modifierExtension |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| language |
1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: CommonLanguages (preferred)
| |||||||||
| preferred |
0..1 | boolean | Language preference indicator | |||||||||
| Documentation for this format | ||||||||||||
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| RelatedPerson |
||
| Slices for extension |
||
| relationship |
|
|
| name |
|
|
| Slices for telecom |
||
| telecom:email |
|
|
| telecom:phone |
|
|
| address |
|
|
| communication |
||
| language |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| RelatedPerson.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| RelatedPerson.relationship | Base | preferred | PersonalRelationshipRoleType | 📦3.0.0 | THO v7.1 |
| RelatedPerson.telecom:email.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:email.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:phone.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:phone.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:internet.system | Base | required | ContactPointSystem | 📍4.0.1 | FHIR Std. |
| RelatedPerson.telecom:internet.use | Base | required | ContactPointUse | 📍4.0.1 | FHIR Std. |
| RelatedPerson.gender | Base | required | AdministrativeGender | 📍4.0.1 | FHIR Std. |
| RelatedPerson.communication.language | Base | preferred | Common Languages | 📦4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | RelatedPerson | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | RelatedPerson | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | RelatedPerson | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | RelatedPerson | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| Name | Creator (IPS) | Consumer (IPS) |
|---|---|---|
| RelatedPerson |
||
| Slices for extension |
||
| relationship |
|
|
| name |
|
|
| Slices for telecom |
||
| telecom:email |
|
|
| telecom:phone |
|
|
| address |
|
|
| communication |
||
| language |
|
|
| Documentation for this format | ||
This structure is derived from CHCoreRelatedPerson
Other representations of profile: CSV, Excel, Schematron