Guide d'implémentation Fr Core
2.0.0-ballot - trial-use
Guide d'implémentation Fr Core
2.0.0-ballot - trial-use
This page is part of the Guide d'implémentation Fr Core (v2.0.0-ballot: Release) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
| Official URL: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-related-person | Version: 2.0.0-ballot | |||
| Draft as of 2024-02-20 | Computable Name: FRCoreRelatedPersonProfile | |||
| Profile of the RelatedPerson resource for France | Profil de la ressource RelatedPerson pour l’usage en France |
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 | ||||
   Slices for profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | |
   profile:fr-canonical | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-related-person | |
 identifier | 1..1 | Identifier | A human identifier for this person | |
 patient | 1..1 | Reference(FR Core Patient Profile) | The patient this person is related to | |
| Slices for relationship | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Open by value:coding.system | |
 relationship:RolePerson | 0..1 | CodeableConcept | The nature of the relationship. Rôle de la personne Binding: FR Core ValueSet Related person role (preferred) | |
  coding | ||||
 system | 1..1 | uri | Identity of the terminology system Required Pattern: https://mos.esante.gouv.fr/NOS/TRE_R260-HL7RoleClass/FHIR/TRE-R260-HL7RoleClass | |
 relationship:RelatedPerson | 0..* | CodeableConcept | The nature of the relationship. Relation de la personne Binding: FR Core ValueSet Related person role (preferred) | |
| coding | ||||
| system | 1..1 | uri | Identity of the terminology system Required Pattern: https://mos.esante.gouv.fr/NOS/TRE_R216-HL7RoleCode/FHIR/TRE-R216-HL7RoleCode | |
 name | 0..* | FRCoreHumanNameProfile | Name of a human - parts and usage | |
| telecom | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
| address | 0..* | FRCoreAddressProfile | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship:RolePerson | preferred | FRCoreValueSetRelatedPersonRolehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-related-person-rolefrom this IG | |
| RelatedPerson.relationship:RelatedPerson | preferred | FRCoreValueSetRelatedPersonhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-related-personfrom this IG |
| 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 | |
 implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 1..1 | 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(FR Core Patient Profile) | The patient this person is related to |
| Slices for relationship | Σ | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Open by value:coding.system Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
 relationship:RolePerson | Σ | 0..1 | CodeableConcept | The nature of the relationship. Rôle de la personne Binding: FR Core ValueSet Related person role (preferred) |
| relationship:RelatedPerson | Σ | 0..* | CodeableConcept | The nature of the relationship. Relation de la personne Binding: FR Core ValueSet Related person role (preferred) |
| name | 0..* | FRCoreHumanNameProfile | Name of a human - parts and usage | |
| telecom | C | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| address | 0..* | FRCoreAddressProfile | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard | |
| RelatedPerson.relationship:RolePerson | preferred | FRCoreValueSetRelatedPersonRolehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-related-person-rolefrom this IG | |
| RelatedPerson.relationship:RelatedPerson | preferred | FRCoreValueSetRelatedPersonhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-related-personfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | RelatedPerson.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| 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 | 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 | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| Slices for profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
| profile:fr-canonical | Σ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-related-person | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..1 | 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(FR Core Patient Profile) | The patient this person is related to | ||||
| Slices for relationship | Σ | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Open by value:coding.system Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
| relationship:RolePerson | Σ | 0..1 | CodeableConcept | The nature of the relationship. Rôle de la personne Binding: FR Core ValueSet Related person role (preferred) | ||||
 id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
 coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
 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 | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://mos.esante.gouv.fr/NOS/TRE_R260-HL7RoleClass/FHIR/TRE-R260-HL7RoleClass | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
 text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| relationship:RelatedPerson | Σ | 0..* | CodeableConcept | The nature of the relationship. Relation de la personne Binding: FR Core ValueSet Related person role (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| 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 | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://mos.esante.gouv.fr/NOS/TRE_R216-HL7RoleCode/FHIR/TRE-R216-HL7RoleCode | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| name | 0..* | FRCoreHumanNameProfile | Name of a human - parts and usage | |||||
| telecom | C | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| 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..* | FRCoreAddressProfile | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
| 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): 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-labelsfrom the FHIR Standard | ||||
| RelatedPerson.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| RelatedPerson.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard | ||||
| RelatedPerson.relationship:RolePerson | preferred | FRCoreValueSetRelatedPersonRolehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-related-person-rolefrom this IG | ||||
| RelatedPerson.relationship:RelatedPerson | preferred | FRCoreValueSetRelatedPersonhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-related-personfrom this IG | ||||
| RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | RelatedPerson.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| 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
Summary
Mandatory: 2 elements (2 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from RelatedPerson
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| RelatedPerson | RelatedPerson | |||
| meta | ||||
| Slices for profile | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | |
| profile:fr-canonical | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-related-person | |
| identifier | 1..1 | Identifier | A human identifier for this person | |
| patient | 1..1 | Reference(FR Core Patient Profile) | The patient this person is related to | |
| Slices for relationship | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Open by value:coding.system | |
| relationship:RolePerson | 0..1 | CodeableConcept | The nature of the relationship. Rôle de la personne Binding: FR Core ValueSet Related person role (preferred) | |
| coding | ||||
| system | 1..1 | uri | Identity of the terminology system Required Pattern: https://mos.esante.gouv.fr/NOS/TRE_R260-HL7RoleClass/FHIR/TRE-R260-HL7RoleClass | |
| relationship:RelatedPerson | 0..* | CodeableConcept | The nature of the relationship. Relation de la personne Binding: FR Core ValueSet Related person role (preferred) | |
| coding | ||||
| system | 1..1 | uri | Identity of the terminology system Required Pattern: https://mos.esante.gouv.fr/NOS/TRE_R216-HL7RoleCode/FHIR/TRE-R216-HL7RoleCode | |
| name | 0..* | FRCoreHumanNameProfile | Name of a human - parts and usage | |
| telecom | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) | |
| address | 0..* | FRCoreAddressProfile | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship:RolePerson | preferred | FRCoreValueSetRelatedPersonRolehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-related-person-rolefrom this IG | |
| RelatedPerson.relationship:RelatedPerson | preferred | FRCoreValueSetRelatedPersonhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-related-personfrom this IG |
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 | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 1..1 | 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(FR Core Patient Profile) | The patient this person is related to |
| Slices for relationship | Σ | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Open by value:coding.system Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. |
| relationship:RolePerson | Σ | 0..1 | CodeableConcept | The nature of the relationship. Rôle de la personne Binding: FR Core ValueSet Related person role (preferred) |
| relationship:RelatedPerson | Σ | 0..* | CodeableConcept | The nature of the relationship. Relation de la personne Binding: FR Core ValueSet Related person role (preferred) |
| name | 0..* | FRCoreHumanNameProfile | Name of a human - parts and usage | |
| telecom | C | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) |
| address | 0..* | FRCoreAddressProfile | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard | |
| RelatedPerson.relationship:RolePerson | preferred | FRCoreValueSetRelatedPersonRolehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-related-person-rolefrom this IG | |
| RelatedPerson.relationship:RelatedPerson | preferred | FRCoreValueSetRelatedPersonhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-related-personfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | RelatedPerson.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| 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() |
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 | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| versionId | Σ | 0..1 | id | Version specific identifier | ||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | ||||
| source | Σ | 0..1 | uri | Identifies where the resource comes from | ||||
| Slices for profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Open by value:$this | ||||
| profile:fr-canonical | Σ | 0..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Required Pattern: https://hl7.fr/ig/fhir/core/StructureDefinition/fr-core-related-person | ||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
| 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 | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 1..1 | 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(FR Core Patient Profile) | The patient this person is related to | ||||
| Slices for relationship | Σ | 1..* | CodeableConcept | The nature of the relationship Slice: Unordered, Open by value:coding.system Binding: PatientRelationshipType (preferred): The nature of the relationship between a patient and the related person. | ||||
| relationship:RolePerson | Σ | 0..1 | CodeableConcept | The nature of the relationship. Rôle de la personne Binding: FR Core ValueSet Related person role (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| 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 | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://mos.esante.gouv.fr/NOS/TRE_R260-HL7RoleClass/FHIR/TRE-R260-HL7RoleClass | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| relationship:RelatedPerson | Σ | 0..* | CodeableConcept | The nature of the relationship. Relation de la personne Binding: FR Core ValueSet Related person role (preferred) | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
| 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 | Σ | 1..1 | uri | Identity of the terminology system Required Pattern: https://mos.esante.gouv.fr/NOS/TRE_R216-HL7RoleCode/FHIR/TRE-R216-HL7RoleCode | ||||
| version | Σ | 0..1 | string | Version of the system - if relevant | ||||
| code | Σ | 0..1 | code | Symbol in syntax defined by the system | ||||
| display | Σ | 0..1 | string | Representation defined by the system | ||||
| userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
| text | Σ | 0..1 | string | Plain text representation of the concept | ||||
| name | 0..* | FRCoreHumanNameProfile | Name of a human - parts and usage | |||||
| telecom | C | 0..* | FRCoreContactPointProfile | Details of a Technology mediated contact point (phone, fax, email, etc.) | ||||
| 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..* | FRCoreAddressProfile | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | |||||
| 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): 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-labelsfrom the FHIR Standard | ||||
| RelatedPerson.meta.tag | example | CommonTagshttp://hl7.org/fhir/ValueSet/common-tagsfrom the FHIR Standard | ||||
| RelatedPerson.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| RelatedPerson.relationship | preferred | PatientRelationshipTypehttp://hl7.org/fhir/ValueSet/relatedperson-relationshiptypefrom the FHIR Standard | ||||
| RelatedPerson.relationship:RolePerson | preferred | FRCoreValueSetRelatedPersonRolehttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-related-person-rolefrom this IG | ||||
| RelatedPerson.relationship:RelatedPerson | preferred | FRCoreValueSetRelatedPersonhttps://hl7.fr/ig/fhir/core/ValueSet/fr-core-vs-related-personfrom this IG | ||||
| RelatedPerson.gender | required | AdministrativeGenderhttp://hl7.org/fhir/ValueSet/administrative-gender|4.0.1from the FHIR Standard | ||||
| RelatedPerson.communication.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| cpt-2 | error | RelatedPerson.telecom | A system is required if a value is provided. : value.empty() or system.exists() | |
| 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
Summary
Mandatory: 2 elements (2 nested mandatory elements)
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron