CareConnect-CDS-RelatedPerson-1
This is the StructureDefinition overview for the CareConnect-CDS-RelatedPerson-1
The official URL for this profile is: https
Differential
| CareConnect-CDS-RelatedPerson-1 (RelatedPerson) | C | CareConnect-RelatedPerson-1 | There are no (further) constraints on this element Element idRelatedPersonShort description An person that is related to a patient, but who is not a direct target of care DefinitionInformation 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.
| |||
| id | S Σ | 1..1 | id | There are no (further) constraints on this element Element idRelatedPerson.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idRelatedPerson.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idRelatedPerson.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1, dom-1 Constraints
| ||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idRelatedPerson.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idRelatedPerson.identifierShort description A human identifier for this person DefinitionIdentifier for a person within a particular scope. 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. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| (All Slices) | The requirements in this element apply to all slices | |||||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.identifier.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.identifier.useShort description usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idRelatedPerson.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| nhsNumber | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumberShort description A human identifier for this person DefinitionIdentifier for a person within a particular scope. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 1..1 | codeBindingFixed Value | Element idRelatedPerson.identifier:nhsNumber.useShort description usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
officialMappings
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idRelatedPerson.identifier:nhsNumber.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.nhs.uk/Id/nhs-numberExamples General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.activeShort description Whether this related person's record is in active use DefinitionWhether this related person record is in active use. Need to be able to mark a related person record as not to be used, such as if it was created in error. This element is labeled as a modifier because it may be used to mark that the resource was created in error. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
trueMappings
| ||
| patient | S Σ C | 1..1 | Reference(CareConnect-CDS-Patient-1) | Element idRelatedPerson.patientShort description The patient this person is related to DefinitionThe patient this person is related to. We need to know which patient this RelatedPerson is related to. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-CDS-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relationship | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.relationshipShort description The nature of the relationship DefinitionThe nature of the relationship between a patient and the related person. We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between a patient and the related person PatientRelationshipType (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.relationship.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 0..* | Coding | Element idRelatedPerson.relationship.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relationshipType | S Σ | 1..1 | Coding | Element idRelatedPerson.relationship.coding:relationshipTypeShort description Code defined by a terminology system DefinitionThe relationshipType is used to identify primary type of relationship (e.g. Parent, Sibling, Spouse, Child, Friend, Neighbour etc.) Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idRelatedPerson.relationship.coding:relationshipType.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Used to identify which RelatedPerson.relationship.coding related to the relationshipType The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://CareDataService/RelatedPerson/relationship-typeMappings
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | code | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relationshipFlag | S Σ | 0..* | Coding | Element idRelatedPerson.relationship.coding:relationshipFlagShort description Code defined by a terminology system DefinitionThe relationshipFlag is used to identify any additional roles the related person or patient perform on behalf of the other (e.g. Carer, Next of Kin, Emergency Contact, Dependent, etc.) Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idRelatedPerson.relationship.coding:relationshipFlag.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Used to identify which RelatedPerson.relationship.coding(s) related to the relationshipFlag The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://CareDataService/RelatedPerson/relationship-flagMappings
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | code | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.textShort description Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 1..* | HumanName | Element idRelatedPerson.nameShort description A name associated with the person DefinitionA name associated with the person. Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. Unordered, Open, by use(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| official | S Σ | 1..1 | HumanName | There are no (further) constraints on this element Element idRelatedPerson.name:officialShort description A name associated with the person DefinitionA name associated with the person. Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.name:official.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 1..1 | codeBindingFixed Value | Element idRelatedPerson.name:official.useShort description usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
officialMappings
| ||
| text | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.textShort description Text representation of the full name DefinitionA full text representation of the name. A renderable, unencoded form. Can provide both a text representation and structured parts. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| family | S Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.familyShort description Family name (often called 'Surname') Alternate namessurname DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| given | S Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.givenShort description Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.prefixShort description Parts that come before the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.suffixShort description Parts that come after the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.name:official.periodShort description Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| telecom | S Σ C | 0..* | ContactPoint | There are no (further) constraints on this element Element idRelatedPerson.telecomShort description A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.genderShort description male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed for identification of the person, in combination with (at least) name and birth date. Note that FHIR strings may not exceed 1MB in size The gender of a person used for administrative purposes. AdministrativeGender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| birthDate | S Σ | 0..1 | date | There are no (further) constraints on this element Element idRelatedPerson.birthDateShort description The date on which the related person was born DefinitionThe date on which the related person was born. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| address | Σ | 0..* | Address | There are no (further) constraints on this element Element idRelatedPerson.addressShort description Address where the related person can be contacted or visited DefinitionAddress where the related person can be contacted or visited. Need to keep track where the related person can be contacted per postal mail or visited. Note: address is for postal addresses, not physical locations. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| photo | C | 0..* | Attachment | There are no (further) constraints on this element Element idRelatedPerson.photoShort description Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Attachment". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.periodShort description Period of time that this relationship is considered valid DefinitionThe period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Hybrid
| CareConnect-CDS-RelatedPerson-1 (RelatedPerson) | C | CareConnect-RelatedPerson-1 | There are no (further) constraints on this element Element idRelatedPersonShort description An person that is related to a patient, but who is not a direct target of care DefinitionInformation 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.
| |||
| id | S Σ | 1..1 | id | There are no (further) constraints on this element Element idRelatedPerson.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idRelatedPerson.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idRelatedPerson.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1, dom-1 Constraints
| ||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idRelatedPerson.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idRelatedPerson.identifierShort description A human identifier for this person DefinitionIdentifier for a person within a particular scope. 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. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| (All Slices) | The requirements in this element apply to all slices | |||||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.identifier.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.identifier.useShort description usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idRelatedPerson.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| nhsNumber | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumberShort description A human identifier for this person DefinitionIdentifier for a person within a particular scope. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 1..1 | codeBindingFixed Value | Element idRelatedPerson.identifier:nhsNumber.useShort description usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
officialMappings
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idRelatedPerson.identifier:nhsNumber.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.nhs.uk/Id/nhs-numberExamples General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.activeShort description Whether this related person's record is in active use DefinitionWhether this related person record is in active use. Need to be able to mark a related person record as not to be used, such as if it was created in error. This element is labeled as a modifier because it may be used to mark that the resource was created in error. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
trueMappings
| ||
| patient | S Σ C | 1..1 | Reference(CareConnect-CDS-Patient-1) | Element idRelatedPerson.patientShort description The patient this person is related to DefinitionThe patient this person is related to. We need to know which patient this RelatedPerson is related to. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-CDS-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relationship | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.relationshipShort description The nature of the relationship DefinitionThe nature of the relationship between a patient and the related person. We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between a patient and the related person PatientRelationshipType (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.relationship.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 0..* | Coding | Element idRelatedPerson.relationship.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relationshipType | S Σ | 1..1 | Coding | Element idRelatedPerson.relationship.coding:relationshipTypeShort description Code defined by a terminology system DefinitionThe relationshipType is used to identify primary type of relationship (e.g. Parent, Sibling, Spouse, Child, Friend, Neighbour etc.) Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idRelatedPerson.relationship.coding:relationshipType.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Used to identify which RelatedPerson.relationship.coding related to the relationshipType The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://CareDataService/RelatedPerson/relationship-typeMappings
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | code | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relationshipFlag | S Σ | 0..* | Coding | Element idRelatedPerson.relationship.coding:relationshipFlagShort description Code defined by a terminology system DefinitionThe relationshipFlag is used to identify any additional roles the related person or patient perform on behalf of the other (e.g. Carer, Next of Kin, Emergency Contact, Dependent, etc.) Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idRelatedPerson.relationship.coding:relationshipFlag.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Used to identify which RelatedPerson.relationship.coding(s) related to the relationshipFlag The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://CareDataService/RelatedPerson/relationship-flagMappings
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | code | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.textShort description Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 1..* | HumanName | Element idRelatedPerson.nameShort description A name associated with the person DefinitionA name associated with the person. Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. Unordered, Open, by use(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| official | S Σ | 1..1 | HumanName | There are no (further) constraints on this element Element idRelatedPerson.name:officialShort description A name associated with the person DefinitionA name associated with the person. Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.name:official.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 1..1 | codeBindingFixed Value | Element idRelatedPerson.name:official.useShort description usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
officialMappings
| ||
| text | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.textShort description Text representation of the full name DefinitionA full text representation of the name. A renderable, unencoded form. Can provide both a text representation and structured parts. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| family | S Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.familyShort description Family name (often called 'Surname') Alternate namessurname DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| given | S Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.givenShort description Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.prefixShort description Parts that come before the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.suffixShort description Parts that come after the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.name:official.periodShort description Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| telecom | S Σ C | 0..* | ContactPoint | There are no (further) constraints on this element Element idRelatedPerson.telecomShort description A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.genderShort description male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed for identification of the person, in combination with (at least) name and birth date. Note that FHIR strings may not exceed 1MB in size The gender of a person used for administrative purposes. AdministrativeGender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| birthDate | S Σ | 0..1 | date | There are no (further) constraints on this element Element idRelatedPerson.birthDateShort description The date on which the related person was born DefinitionThe date on which the related person was born. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| address | Σ | 0..* | Address | There are no (further) constraints on this element Element idRelatedPerson.addressShort description Address where the related person can be contacted or visited DefinitionAddress where the related person can be contacted or visited. Need to keep track where the related person can be contacted per postal mail or visited. Note: address is for postal addresses, not physical locations. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| photo | C | 0..* | Attachment | There are no (further) constraints on this element Element idRelatedPerson.photoShort description Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Attachment". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.periodShort description Period of time that this relationship is considered valid DefinitionThe period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
Snapshot (default)
| CareConnect-CDS-RelatedPerson-1 (RelatedPerson) | C | CareConnect-RelatedPerson-1 | There are no (further) constraints on this element Element idRelatedPersonShort description An person that is related to a patient, but who is not a direct target of care DefinitionInformation 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.
| |||
| id | S Σ | 1..1 | id | There are no (further) constraints on this element Element idRelatedPerson.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idRelatedPerson.metaShort description Metadata about the resource DefinitionThe 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| implicitRules | Σ ?! | 0..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| language | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. 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). A human language. Binding extensions
The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| text | C | 0..1 | Narrative | There are no (further) constraints on this element Element idRelatedPerson.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA 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. 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. The cardinality or value of this element may be affected by these constraints: ele-1, dom-1 Constraints
| ||
| contained | 0..* | Resource | There are no (further) constraints on this element Element idRelatedPerson.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese 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. 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.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| identifier | Σ | 0..* | Identifier | Element idRelatedPerson.identifierShort description A human identifier for this person DefinitionIdentifier for a person within a particular scope. 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. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| (All Slices) | The requirements in this element apply to all slices | |||||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.identifier.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.identifier.useShort description usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 0..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idRelatedPerson.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| nhsNumber | S Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumberShort description A human identifier for this person DefinitionIdentifier for a person within a particular scope. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 1..1 | codeBindingFixed Value | Element idRelatedPerson.identifier:nhsNumber.useShort description usual | official | temp | secondary (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known . ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
officialMappings
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idRelatedPerson.identifier:nhsNumber.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. see http://en.wikipedia.org/wiki/Uniform_resource_identifier The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
https://fhir.nhs.uk/Id/nhs-numberExamples General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
General 123456Mappings
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| assigner | Σ C | 0..1 | Reference(CareConnect-Organization-1) | There are no (further) constraints on this element Element idRelatedPerson.identifier:nhsNumber.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. Reference(CareConnect-Organization-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.activeShort description Whether this related person's record is in active use DefinitionWhether this related person record is in active use. Need to be able to mark a related person record as not to be used, such as if it was created in error. This element is labeled as a modifier because it may be used to mark that the resource was created in error. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
trueMappings
| ||
| patient | S Σ C | 1..1 | Reference(CareConnect-CDS-Patient-1) | Element idRelatedPerson.patientShort description The patient this person is related to DefinitionThe patient this person is related to. We need to know which patient this RelatedPerson is related to. References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository. Reference(CareConnect-CDS-Patient-1) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relationship | Σ | 1..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.relationshipShort description The nature of the relationship DefinitionThe nature of the relationship between a patient and the related person. We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. The nature of the relationship between a patient and the related person PatientRelationshipType (preferred) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.relationship.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| coding | Σ | 0..* | Coding | Element idRelatedPerson.relationship.codingShort description Code defined by a terminology system DefinitionA reference to a code defined by a terminology system. Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. Unordered, Open, by system(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relationshipType | S Σ | 1..1 | Coding | Element idRelatedPerson.relationship.coding:relationshipTypeShort description Code defined by a terminology system DefinitionThe relationshipType is used to identify primary type of relationship (e.g. Parent, Sibling, Spouse, Child, Friend, Neighbour etc.) Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idRelatedPerson.relationship.coding:relationshipType.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Used to identify which RelatedPerson.relationship.coding related to the relationshipType The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://CareDataService/RelatedPerson/relationship-typeMappings
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | code | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipType.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| relationshipFlag | S Σ | 0..* | Coding | Element idRelatedPerson.relationship.coding:relationshipFlagShort description Code defined by a terminology system DefinitionThe relationshipFlag is used to identify any additional roles the related person or patient perform on behalf of the other (e.g. Carer, Next of Kin, Emergency Contact, Dependent, etc.) Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| system | Σ | 1..1 | uriFixed Value | Element idRelatedPerson.relationship.coding:relationshipFlag.systemShort description Identity of the terminology system DefinitionThe identification of the code system that defines the meaning of the symbol in the code. Used to identify which RelatedPerson.relationship.coding(s) related to the relationshipFlag The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
http://CareDataService/RelatedPerson/relationship-flagMappings
| ||
| version | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.versionShort description Version of the system - if relevant DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| code | Σ | 0..1 | code | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.codeShort description Symbol in syntax defined by the system DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). Need to refer to a particular code in the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| display | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.displayShort description Representation defined by the system DefinitionA representation of the meaning of the code in the system, following the rules of the system. Need to be able to carry a human-readable meaning of the code for readers that do not know the system. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| userSelected | Σ | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.relationship.coding:relationshipFlag.userSelectedShort description If this coding was chosen directly by the user DefinitionIndicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.relationship.textShort description Plain text representation of the concept DefinitionA 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. 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. Very often the text is the same as a displayName of one of the codings. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| name | Σ | 1..* | HumanName | Element idRelatedPerson.nameShort description A name associated with the person DefinitionA name associated with the person. Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. Unordered, Open, by use(Value) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| official | S Σ | 1..1 | HumanName | There are no (further) constraints on this element Element idRelatedPerson.name:officialShort description A name associated with the person DefinitionA name associated with the person. Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. Names may be changed, or repudiated, or people may have different names in different contexts. Names may be divided into parts of different type that have variable significance depending on context, though the division into parts does not always matter. With personal names, the different parts may or may not be imbued with some implicit meaning; various cultures associate different importance with the name parts and the degree to which systems must care about name parts around the world varies widely. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.name:official.extensionShort description Additional Content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| use | Σ ?! | 1..1 | codeBindingFixed Value | Element idRelatedPerson.name:official.useShort description usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. This is labeled as "Is Modifier" because applications should not mistake a temporary or old name etc.for a current/permanent one. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
officialMappings
| ||
| text | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.textShort description Text representation of the full name DefinitionA full text representation of the name. A renderable, unencoded form. Can provide both a text representation and structured parts. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| family | S Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.familyShort description Family name (often called 'Surname') Alternate namessurname DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| given | S Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.givenShort description Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. If only initials are recorded, they may be used in place of the full name. Not called "first name" since given names do not always come first. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.prefixShort description Parts that come before the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.name:official.suffixShort description Parts that come after the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name. Note that FHIR strings may not exceed 1MB in size The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | Σ C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.name:official.periodShort description Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| telecom | S Σ C | 0..* | ContactPoint | There are no (further) constraints on this element Element idRelatedPerson.telecomShort description A contact detail for the person DefinitionA contact detail for the person, e.g. a telephone number or an email address. People have (primary) ways to contact them in some way such as phone, email. 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. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.genderShort description male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed for identification of the person, in combination with (at least) name and birth date. Note that FHIR strings may not exceed 1MB in size The gender of a person used for administrative purposes. AdministrativeGender (required) ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| birthDate | S Σ | 0..1 | date | There are no (further) constraints on this element Element idRelatedPerson.birthDateShort description The date on which the related person was born DefinitionThe date on which the related person was born. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| address | Σ | 0..* | Address | There are no (further) constraints on this element Element idRelatedPerson.addressShort description Address where the related person can be contacted or visited DefinitionAddress where the related person can be contacted or visited. Need to keep track where the related person can be contacted per postal mail or visited. Note: address is for postal addresses, not physical locations. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| photo | C | 0..* | Attachment | There are no (further) constraints on this element Element idRelatedPerson.photoShort description Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. When providing a summary view (for example with Observation.value[x]) Attachment should be represented with a brief display text such as "Attachment". The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| period | C | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.periodShort description Period of time that this relationship is considered valid DefinitionThe period of time that this relationship is considered to be valid. If there are no dates defined, then the interval is unknown. This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
|
RelatedPerson Data Mapping
The table below provides the business context data mappings for the 'Mandatory' and 'Must Support' elements in the CareConnect-CDS-RelatedPerson-1 profile. The CareConnect-CDS-RelatedPerson-1 profile is used to share detail of individuals that the Local Authority have recorded as having a relationship to the patient.
| FHIR Element | Card. | Type | Description/Business Context |
|---|---|---|---|
| RelatedPerson.id | 1..1 | id | Logical id of related person from Social Care System and used for referencing resource within the Bundle |
| RelatedPerson.identifier | 0..* | identifier | Constraint: Multiple identifiers may be provided, however providers MUST SUPPORT one being the NHS Number so that clients can link to local record of related person |
| RelatedPerson.identifier[nhsNumber] | 0..1 | identifier | Constraint: For the NHS Number: Patient.identifier.use = 'official'Patient.identifier.system = 'https |
| RelatedPerson.patient | 1..1 | Reference (CareConnect-CDS-Patient-1) | Reference to the patient this person is related to |
| RelatedPerson.name | 1..* | HumanName | Constraint: Multiple names may be provided, however one SHALL be the official name, i.e. RelatedPerson.name.use = 'official' |
| RelatedPerson.relationship.coding | 1..* | coding | Constraint: Multiple relationship.codings are allowed, however one MUST be the relationshipType and implementers MUST SUPPORT th epossibility of multiple relationshipFlags (see below) |
| RelatedPerson.relationship.coding |
1..1 | coding | The relationshipType is used to identify primary type of relationship (e.g. Parent, Sibling, Spouse, Child, Friend, Neighbour etc.) |
| RelatedPerson.relationship.coding |
1..1 | uri | Fixed Value http |
| RelatedPerson.relationship.coding |
1..1 | string | Plain text representation of relationship type for display in a user interface.Note coding.code is not required/supported as http |
| RelatedPerson.relationship.coding |
0..* | coding | The relationshipFlag is used to identify any additional roles the related person or patient perform on behalf of the other (e.g. Carer, Next of Kin, Emergency Contact, Dependent, etc.) |
| RelatedPerson.relationship.coding |
1..1 | uri | Each relationshipFlag MUST have a system wthFixed Value http |
| RelatedPerson.relationship.coding |
1..1 | string | Each relationshipFlag MUST have a plain text representation of relationship flag for display in a user interface.Note coding.code is not required/supported as http |
| RelatedPerson.name[official].text | 1..1 | string | Constraint: Where RelatedPerson.name.use='official', RelatedPerson.name.text SHALL be provided |
| RelatedPerson.name[official].family | 1..1 | string | Constraint: Where RelatedPerson.name.use='official', RelatedPerson.name.family SHALL be provided |
| RelatedPerson.name[official].given | 0..* | string | Constraint: Where recorded in the source system, and if RelatedPerson.name.use='official', RelatedPerson.name.given MUST BE SUPPORTED |
| RelatedPerson.telecom | 0..* | ContactPoint | Optional data element for the contact points for a given contact (e.g. phone, fax, email, etc.) |
| RelatedPerson.birthdate | 0..1 | date | The date on which the related person was born. This could be key, for example an Emergency Department needed to see that a Patient being admitted was the main carer of a minor. |