Definitions for the ehealth-related-person Profile.
RelatedPerson | |
Definition | Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. |
Control | 0..* |
Invariants | Defined on this element dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty()) dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) |
RelatedPerson.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
RelatedPerson.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
RelatedPerson.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
RelatedPerson.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language. The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable |
Type | code |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
RelatedPerson.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. |
RelatedPerson.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. |
RelatedPerson.extension | |
Definition | An Extension |
Control | 0..* |
Type | Extension |
RelatedPerson.extension ([CanonicalType[http://ehealth.sundhed.dk/fhir/StructureDefinition/ehealth-patient-contactnote]]) | |
Definition | An Extension |
Control | 0..1 |
Type | Extension(PatientContactNote) (Extension Type: string) |
RelatedPerson.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
RelatedPerson.identifier | |
Definition | Identifier for a person within a particular scope. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. |
RelatedPerson.identifier(dk-civil-registration-number) | |
Definition | Identifier for a person within a particular scope. |
Note | This is a business identifier, not a resource identifier (see discussion) |
Control | 1..1 |
Type | Identifier(DK CRN Identifier) |
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. |
RelatedPerson.active | |
Definition | Whether this related person record is in active use. |
Control | 0..1 |
Type | boolean |
Is Modifier | true |
Requirements | Need to be able to mark a related person record as not to be used, such as if it was created in error. |
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
Default Value | true |
RelatedPerson.patient | |
Definition | The patient this person is related to. |
Control | 1..1 |
Type | Reference(ehealth-patient) |
Requirements | We need to know which patient this RelatedPerson is related to. |
RelatedPerson.relationship | |
Definition | The nature of the relationship between a patient and the related person. |
Control | 0..1 |
Binding | The codes SHALL be taken from RelationshipTypes |
Type | CodeableConcept |
Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. |
RelatedPerson.relationship.id | |
Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Control | 0..1 |
Type | string |
RelatedPerson.relationship.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
RelatedPerson.relationship.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Binding | The codes SHALL be taken from RelationshipTypes |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
RelatedPerson.relationship.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 |
Type | string |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
RelatedPerson.name | |
Definition | A name associated with the person. |
Control | 1..* |
Type | HumanName |
Requirements | Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. |
RelatedPerson.telecom | |
Definition | A contact detail for the person, e.g. a telephone number or an email address. |
Control | 0..* |
Type | ContactPoint |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. |
RelatedPerson.gender | |
Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
Control | 0..1 |
Binding | The gender of a person used for administrative purposes. The codes SHALL be taken from AdministrativeGender |
Type | code |
Requirements | Needed for identification of the person, in combination with (at least) name and birth date. |
RelatedPerson.birthDate | |
Definition | The date on which the related person was born. |
Control | 0..1 |
Type | date |
RelatedPerson.address | |
Definition | Address where the related person can be contacted or visited. |
Control | 0..* |
Type | Address |
Requirements | Need to keep track where the related person can be contacted per postal mail or visited. |
RelatedPerson.photo | |
Definition | Image of the person. |
Control | 0..* |
Type | Attachment |
Requirements | Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. |
RelatedPerson.period | |
Definition | The period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown. |
Control | 0..1 |
Type | Period |