CH EMED EPR
2.0.0-ci-build - ci-build
CH EMED EPR, published by CARA. This guide is not an authorized publication; it is the continuous build for version 2.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/CARA-ch/ch-emed-epr/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.ch/ig/ch-emed-epr/StructureDefinition/ch-emed-epr-related-person | Version: 2.0.0-ci-build | |||
Draft as of 2024-12-20 | Computable Name: CHEMEDEPRRelatedPerson | |||
Copyright/Legal: CC0-1.0 |
Definition of the related person for the eMedication context
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from RelatedPerson
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | RelatedPerson | |||
meta | ||||
extension | D | 0..* | Extension | ✕ This element is not supported |
versionId | D | 0..1 | id | ✕ This element is not supported |
lastUpdated | D | 0..1 | instant | ✕ This element is not supported |
source | D | 0..1 | uri | ✕ This element is not supported |
security | D | 0..* | Coding | ✕ This element is not supported |
tag | D | 0..* | Coding | ✕ This element is not supported |
implicitRules | 0..0 | |||
modifierExtension | 0..0 | |||
identifier | ||||
extension | D | 0..* | Extension | ✕ This element is not supported |
type | D | 0..1 | CodeableConcept | ✕ This element is not supported |
period | D | 0..1 | Period | ✕ This element is not supported |
assigner | D | 0..1 | Reference(CH EMED EPR Organization) | ✕ This element will be removed in PML(C) documents |
active | D | 0..1 | boolean | ✕ This element is not supported |
period | D | 0..1 | Period | ✕ This element is not supported |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
active | ?!ΣD | 0..1 | boolean | ✕ This element is not supported ele-1: All FHIR elements must have a @value or children |
patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to ele-1: All FHIR elements must have a @value or children |
period | D | 0..1 | Period | ✕ This element is not supported ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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()) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | ||||
versionId | ΣD | 0..1 | id | ✕ This element is not supported | ||||
lastUpdated | ΣD | 0..1 | instant | ✕ This element is not supported | ||||
source | ΣD | 0..1 | uri | ✕ This element is not supported | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | ΣD | 0..* | Coding | ✕ This element is not supported Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | ΣD | 0..* | Coding | ✕ This element is not supported Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
identifier | Σ | 0..* | Identifier | A human identifier for this person | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | ΣD | 0..1 | CodeableConcept | ✕ This element is not supported Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | ΣD | 0..1 | Period | ✕ This element is not supported | ||||
assigner | ΣD | 0..1 | Reference(CH EMED EPR Organization) | ✕ This element will be removed in PML(C) documents | ||||
active | ?!ΣD | 0..1 | boolean | ✕ This element is not supported | ||||
patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to | ||||
relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
name | Σ | 0..* | HumanName | A name associated with the person | ||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the person | ||||
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..* | Address | Address where the related person can be contacted or visited | ||||
photo | 0..* | Attachment | Image of the person | |||||
period | D | 0..1 | Period | ✕ This element is not supported | ||||
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): A human language.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
RelatedPerson.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
RelatedPerson.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
RelatedPerson.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
RelatedPerson.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard | ||||
RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
RelatedPerson.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
|
Id | Grade | Path(s) | Details | Requirements |
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 RelatedPerson
Differential View
This structure is derived from RelatedPerson
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | RelatedPerson | |||
meta | ||||
extension | D | 0..* | Extension | ✕ This element is not supported |
versionId | D | 0..1 | id | ✕ This element is not supported |
lastUpdated | D | 0..1 | instant | ✕ This element is not supported |
source | D | 0..1 | uri | ✕ This element is not supported |
security | D | 0..* | Coding | ✕ This element is not supported |
tag | D | 0..* | Coding | ✕ This element is not supported |
implicitRules | 0..0 | |||
modifierExtension | 0..0 | |||
identifier | ||||
extension | D | 0..* | Extension | ✕ This element is not supported |
type | D | 0..1 | CodeableConcept | ✕ This element is not supported |
period | D | 0..1 | Period | ✕ This element is not supported |
assigner | D | 0..1 | Reference(CH EMED EPR Organization) | ✕ This element will be removed in PML(C) documents |
active | D | 0..1 | boolean | ✕ This element is not supported |
period | D | 0..1 | Period | ✕ This element is not supported |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
active | ?!ΣD | 0..1 | boolean | ✕ This element is not supported ele-1: All FHIR elements must have a @value or children |
patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to ele-1: All FHIR elements must have a @value or children |
period | D | 0..1 | Period | ✕ This element is not supported ele-1: All FHIR elements must have a @value or children |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
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()) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
RelatedPerson | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care | |||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | ||||
versionId | ΣD | 0..1 | id | ✕ This element is not supported | ||||
lastUpdated | ΣD | 0..1 | instant | ✕ This element is not supported | ||||
source | ΣD | 0..1 | uri | ✕ This element is not supported | ||||
profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
security | ΣD | 0..* | Coding | ✕ This element is not supported Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
tag | ΣD | 0..* | Coding | ✕ This element is not supported Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
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 | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
identifier | Σ | 0..* | Identifier | A human identifier for this person | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | D | 0..* | Extension | ✕ This element is not supported Slice: Unordered, Open by value:url | ||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | ΣD | 0..1 | CodeableConcept | ✕ This element is not supported Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
period | ΣD | 0..1 | Period | ✕ This element is not supported | ||||
assigner | ΣD | 0..1 | Reference(CH EMED EPR Organization) | ✕ This element will be removed in PML(C) documents | ||||
active | ?!ΣD | 0..1 | boolean | ✕ This element is not supported | ||||
patient | Σ | 1..1 | Reference(Patient) | The patient this person is related to | ||||
relationship | Σ | 0..* | CodeableConcept | The nature of the relationship Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
name | Σ | 0..* | HumanName | A name associated with the person | ||||
telecom | Σ | 0..* | ContactPoint | A contact detail for the person | ||||
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..* | Address | Address where the related person can be contacted or visited | ||||
photo | 0..* | Attachment | Image of the person | |||||
period | D | 0..1 | Period | ✕ This element is not supported | ||||
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): A human language.
| |||||
preferred | 0..1 | boolean | Language preference indicator | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
RelatedPerson.meta.security | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard | ||||
RelatedPerson.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tags from the FHIR Standard | ||||
RelatedPerson.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
RelatedPerson.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
RelatedPerson.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptype from the FHIR Standard | ||||
RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1 from the FHIR Standard | ||||
RelatedPerson.communication.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
|
Id | Grade | Path(s) | Details | Requirements |
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 RelatedPerson
Other representations of profile: CSV, Excel, Schematron