Profiles
StructureDefinition England-RelatedPerson-PDS
Canonical_URL | Status | Current_Version | Last_Updated | Description |
---|---|---|---|---|
https://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-PDS | draft | 0.0.1-current | 2024-10-25T07:31:19+00:00 | Based on NHS England Confluence - Related Person Network - Physical Data Model - LPG |
Profile_Purpose |
---|
This documents requirement for NHS England PDS |
Detailed Descriptions
RelatedPerson | |
Definition | Information about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
RelatedPerson.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
RelatedPerson.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
RelatedPerson.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
RelatedPerson.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
RelatedPerson.text | |
Definition | A human-readable narrative that contains a summary of the resource and can 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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
RelatedPerson.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
RelatedPerson.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.extension:contactPreference | |
Definition | The preferred method of contact, contact times and written communication format given by a Patient or Related Person. |
Cardinality | 0...1 |
Type | Extension(Complex) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.extension:copyCorrespondenceIndicator | |
Definition | Extension carrying a boolean indicator showing that a patient's contact or related person SHALL be copied in to patient correspondence. |
Cardinality | 0...1 |
Type | Extension(boolean) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.extension:ContactRank | |
Definition | The preferred ranking or order of contact applied to a contact on a patient's contact list. |
Cardinality | 0...1 |
Type | Extension(positiveInt) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.extension:interpreterRequired | |
Definition | This Patient requires an interpreter to communicate healthcare information to the practitioner. |
Cardinality | 0...1 |
Type | Extension(boolean) |
Alias | extensions, user content |
Comments | The Patient does not speak the default language of the organization, and hence requires an interpreter. If the patient has other languages in the Communications list, then that would be the type of interpreter required. |
Invariants |
|
Mappings |
|
RelatedPerson.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.identifier | |
Definition | Identifier for a person within a particular scope. |
Cardinality | 0...* |
Type | Identifier |
Must Support | True |
Summary | True |
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. |
Slicing | Unordered, Closed, by system(Pattern) |
Invariants |
|
Mappings |
|
RelatedPerson.identifier:NHSNumber | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | EnglandIdentifierNHSNumber |
Summary | True |
Requirements | People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier. |
Invariants |
|
Mappings |
|
RelatedPerson.active | |
Definition | Whether this related person record is in active use. |
Cardinality | 0...1 |
Type | boolean |
Must Support | True |
Modifier | True |
Summary | True |
Requirements | Need to be able to mark a related person record as not to be used, such as if it was created in error. |
Comments | This element is labeled as a modifier because it may be used to mark that the resource was created in error. |
Invariants |
|
Mappings |
|
RelatedPerson.patient | |
Definition | The patient this person is related to. |
Cardinality | 1...1 |
Type | Reference(Patient) |
Must Support | True |
Summary | True |
Requirements | We need to know which patient this RelatedPerson is related to. |
Invariants |
|
Mappings |
|
RelatedPerson.patient.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.patient.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.patient.reference | |
Definition | A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Invariants |
|
Mappings |
|
RelatedPerson.patient.type | |
Definition | The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL, both SHALL be consistent. The type is the Canonical URL of Resource Definition that is the type this reference refers to. References are URLs that are relative to http://hl7.org/fhir/StructureDefinition/ e.g. "Patient" is a reference to http://hl7.org/fhir/StructureDefinition/Patient. Absolute URLs are only allowed for logical models (and can only be used in references in logical models, not resources). |
Cardinality | 0...1 |
Type | uri |
Binding | Aa resource (or, for logical models, the URI of the logical model). |
Summary | True |
Comments | This element is used to indicate the type of the target of the reference. This may be used which ever of the other elements are populated (or not). In some cases, the type of the target may be determined by inspection of the reference (e.g. a RESTful URL) or by resolving the target of the reference; if both the type and a reference is provided, the reference SHALL resolve to a resource of the same type as that specified. |
Invariants |
|
Mappings |
|
RelatedPerson.patient.identifier | |
Definition | An identifier - identifies some entity uniquely and unambiguously. Typically this is used for business identifiers. |
Cardinality | 0...1 |
Type | EnglandIdentifierNHSNumber |
Summary | True |
Comments | When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. When both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference Applications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it. Reference is intended to point to a structure that can potentially be expressed as a FHIR resource, though there is no need for it to exist as an actual FHIR resource instance - except in as much as an application wishes to actual find the target of the reference. The content referred to be the identifier must meet the logical constraints implied by any limitations on what resource types are permitted for the reference. For example, it would not be legitimate to send the identifier for a drug prescription if the type were Reference(Observation|DiagnosticReport). One of the use-cases for Reference.identifier is the situation where no FHIR representation exists (where the type is Reference (Any). |
Invariants |
|
Mappings |
|
RelatedPerson.patient.display | |
Definition | Plain text narrative that identifies the resource in addition to the resource reference. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship | |
Definition | The nature of the relationship between a patient and the related person. |
Cardinality | 1...3 |
Type | CodeableConcept |
Binding | The nature of the relationship between a patient and the related person. |
Must Support | True |
Summary | True |
Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. |
Slicing | Unordered, Open At End, by coding.system(Pattern) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.relationship.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Binding | EnglandPDSRelationshipType (preferred) |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.relationship.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding.code | |
Definition | A 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). |
Cardinality | 1...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Role | |
Definition | The nature of the relationship between a patient and the related person. |
Cardinality | 0...2 |
Type | CodeableConcept |
Binding | The nature of the relationship between a patient and the related person. |
Must Support | True |
Summary | True |
Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Role.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.relationship:Role.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Role.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Role.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.relationship:Role.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Role.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Pattern | https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole |
Mappings |
|
RelatedPerson.relationship:Role.coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Role.coding.code | |
Definition | A 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). |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Role.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Role.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Role.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Type | |
Definition | The nature of the relationship between a patient and the related person. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The nature of the relationship between a patient and the related person. |
Must Support | True |
Summary | True |
Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Type.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.relationship:Type.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Type.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.relationship:Type.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Pattern | http://terminology.hl7.org/CodeSystem/v3-RoleCode |
Mappings |
|
RelatedPerson.relationship:Type.coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Type.coding.code | |
Definition | A 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). |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:Type.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:NextOfKin | |
Definition | The nature of the relationship between a patient and the related person. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The nature of the relationship between a patient and the related person. |
Must Support | True |
Summary | True |
Requirements | We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:NextOfKin.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.relationship:NextOfKin.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:NextOfKin.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:NextOfKin.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.relationship:NextOfKin.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:NextOfKin.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 0...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | 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 reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Pattern | http://terminology.hl7.org/CodeSystem/v2-0131 |
Mappings |
|
RelatedPerson.relationship:NextOfKin.coding.version | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | 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. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:NextOfKin.coding.code | |
Definition | A 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). |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:NextOfKin.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:NextOfKin.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | 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. |
Comments | 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. |
Invariants |
|
Mappings |
|
RelatedPerson.relationship:NextOfKin.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
RelatedPerson.name | |
Definition | A name associated with the person. |
Cardinality | 1...1 |
Type | HumanName |
Must Support | True |
Summary | True |
Requirements | Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person. |
Invariants |
|
Mappings |
|
RelatedPerson.name.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.use | |
Definition | Identifies the purpose for this name. |
Cardinality | 1...1 |
Type | code |
Binding | The use of a human name. |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate name for a particular context of use to be selected from among a set of names. |
Comments | Applications can assume that a name is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Mappings |
|
RelatedPerson.name.text | |
Definition | Specifies the entire name as it should be displayed e.g. on an application UI. This may be provided instead of or as well as the specific parts. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. Applications updating a name SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
Invariants |
|
Mappings |
|
RelatedPerson.name.family | |
Definition | The 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. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | surname |
Comments | Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures). |
Invariants |
|
Mappings |
|
RelatedPerson.name.given | |
Definition | Given name. |
Cardinality | 0...* |
Type | string |
Summary | True |
Alias | first name, middle name |
Comments | If only initials are recorded, they may be used in place of the full name parts. Initials may be separated into multiple given names but often aren't due to paractical limitations. This element is not called "first name" since given names do not always come first. |
Invariants |
|
Mappings |
|
RelatedPerson.name.prefix | |
Definition | Part 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. |
Cardinality | 0...* |
Type | string |
Summary | True |
Invariants |
|
Mappings |
|
RelatedPerson.name.suffix | |
Definition | Part 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. |
Cardinality | 0...* |
Type | string |
Summary | True |
Invariants |
|
Mappings |
|
RelatedPerson.name.period | |
Definition | Indicates the period of time when this name was valid for the named person. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows names to be placed in historical context. |
Invariants |
|
Mappings |
|
RelatedPerson.name.period.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.name.period.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.name.period.start | |
Definition | The start of the period. The boundary is inclusive. |
Cardinality | 1...1 |
Type | dateTime |
Summary | True |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Invariants |
|
Mappings |
|
RelatedPerson.name.period.end | |
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom | |
Definition | A contact detail for the person, e.g. a telephone number or an email address. |
Cardinality | 0...* |
Type | ContactPoint |
Must Support | True |
Summary | True |
Requirements | People have (primary) ways to contact them in some way such as phone, email. |
Comments | Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.telecom.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.system | |
Definition | Telecommunications form for contact point - what communications system is required to make use of the contact. |
Cardinality | 0...1 |
Type | code |
Binding | Telecommunications form for contact point. |
Summary | True |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.system.id | |
Definition | unique id for the element within a resource (for internal references) |
Cardinality | 0...1 |
Type | string |
RelatedPerson.telecom.system.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
RelatedPerson.telecom.system.extension:otherContactSystem | |
Definition | Other contact system value which extends the system element in the ContactPoint datatype. |
Cardinality | 0...1 |
Type | Extension(CodeableConcept) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.system.value | |
Definition | Primitive value for code |
Cardinality | 0...1 |
Type | System.String |
RelatedPerson.telecom.value | |
Definition | The actual contact point details, in a form that is meaningful to the designated communication system (i.e. phone number or email address). |
Cardinality | 1...1 |
Type | string |
Summary | True |
Requirements | Need to support legacy numbers that are not in a tightly controlled format. |
Comments | Additional text data such as phone extension numbers, or notes about use of the contact are sometimes included in the value. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.use | |
Definition | Identifies the purpose for the contact point. |
Cardinality | 1...1 |
Type | code |
Binding | Use of contact point. |
Modifier | True |
Summary | True |
Requirements | Need to track the way a person uses this contact, so a user can choose which is appropriate for their purpose. |
Comments | Applications can assume that a contact is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.rank | |
Definition | Specifies a preferred order in which to use a set of contacts. ContactPoints with lower rank values are more preferred than those with higher rank values. |
Cardinality | 0...1 |
Type | positiveInt |
Summary | True |
Comments | Note that rank does not necessarily follow the order in which the contacts are represented in the instance. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.period | |
Definition | Time period when the contact point was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.period.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.telecom.period.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.period.start | |
Definition | The start of the period. The boundary is inclusive. |
Cardinality | 1...1 |
Type | dateTime |
Summary | True |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Invariants |
|
Mappings |
|
RelatedPerson.telecom.period.end | |
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
Invariants |
|
Mappings |
|
RelatedPerson.gender | |
Definition | Administrative Gender - the gender that the person is considered to have for administration and record keeping purposes. |
Cardinality | 0...1 |
Type | code |
Binding | The gender of a person used for administrative purposes. |
Summary | True |
Requirements | Needed for identification of the person, in combination with (at least) name and birth date. |
Invariants |
|
Mappings |
|
RelatedPerson.birthDate | |
Definition | The date on which the related person was born. |
Cardinality | 0...1 |
Type | date |
Must Support | True |
Summary | True |
Invariants |
|
Mappings |
|
RelatedPerson.address | |
Definition | Address where the related person can be contacted or visited. |
Cardinality | 0...* |
Type | Address |
Must Support | True |
Summary | True |
Requirements | Need to keep track where the related person can be contacted per postal mail or visited. |
Invariants |
|
Mappings |
|
RelatedPerson.address.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.extension:AddressKey | |
Definition | An extension carrying the address key and type. |
Cardinality | 0...* |
Type | Extension(Complex) |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.address.use | |
Definition | The purpose of this address. |
Cardinality | 1...1 |
Type | code |
Binding | The use of an address. |
Modifier | True |
Summary | True |
Requirements | Allows an appropriate address to be chosen from a list of many. |
Comments | Applications can assume that an address is current unless it explicitly says that it is temporary or old. |
Invariants |
|
Examples | General home |
Mappings |
|
RelatedPerson.address.type | |
Definition | Distinguishes between physical addresses (those you can visit) and mailing addresses (e.g. PO Boxes and care-of addresses). Most addresses are both. |
Cardinality | 0...1 |
Type | code |
Binding | The type of an address (physical / postal). |
Summary | True |
Comments | The definition of Address states that "address is intended to describe postal addresses, not physical locations". However, many applications track whether an address has a dual purpose of being a location that can be visited as well as being a valid delivery destination, and Postal addresses are often used as proxies for physical locations (also see the Location resource). |
Invariants |
|
Examples | General both |
Mappings |
|
RelatedPerson.address.text | |
Definition | Specifies the entire address as it should be displayed e.g. on a postal label. This may be provided instead of or as well as the specific parts. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | A renderable, unencoded form. |
Comments | Can provide both a text representation and parts. Applications updating an address SHALL ensure that when both text and parts are present, no content is included in the text that isn't found in a part. |
Invariants |
|
Examples | General 137 Nowhere Street, Erewhon 9132 |
Mappings |
|
RelatedPerson.address.line | |
Definition | This component contains the house number, apartment number, street name, street direction, P.O. Box number, delivery hints, and similar address information. |
Cardinality | 0...* |
Type | string |
Summary | True |
Invariants |
|
Examples | General 137 Nowhere Street |
Mappings |
|
RelatedPerson.address.city | |
Definition | The name of the city, town, suburb, village or other community or delivery center. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Municpality |
Invariants |
|
Examples | General Erewhon |
Mappings |
|
RelatedPerson.address.district | |
Definition | The name of the administrative area (county). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | County |
Comments | District is sometimes known as county, but in some regions 'county' is used in place of city (municipality), so county name should be conveyed in city instead. |
Invariants |
|
Examples | General Madison |
Mappings |
|
RelatedPerson.address.state | |
Definition | Sub-unit of a country with limited sovereignty in a federally organized country. A code may be used if codes are in common use (e.g. US 2 letter state codes). |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Province, Territory |
Invariants |
|
Mappings |
|
RelatedPerson.address.postalCode | |
Definition | A postal code designating a region defined by the postal service. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Zip |
Invariants |
|
Examples | General 9132 |
Mappings |
|
RelatedPerson.address.country | |
Definition | Country - a nation as commonly understood or generally accepted. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | ISO 3166 3 letter codes can be used in place of a human readable country name. |
Invariants |
|
Mappings |
|
RelatedPerson.address.period | |
Definition | Time period when address was/is in use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Requirements | Allows addresses to be placed in historical context. |
Invariants |
|
Examples | General { "start": "2010-03-23", "end": "2010-07-01" } |
Mappings |
|
RelatedPerson.address.period.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.address.period.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.address.period.start | |
Definition | The start of the period. The boundary is inclusive. |
Cardinality | 1...1 |
Type | dateTime |
Summary | True |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Invariants |
|
Mappings |
|
RelatedPerson.address.period.end | |
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
Invariants |
|
Mappings |
|
RelatedPerson.photo | |
Definition | Image of the person. |
Cardinality | 0...* |
Type | Attachment |
Requirements | Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too. |
Invariants |
|
Mappings |
|
RelatedPerson.period | |
Definition | The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown. |
Cardinality | 0...1 |
Type | Period |
Invariants |
|
Mappings |
|
RelatedPerson.period.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.period.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
RelatedPerson.period.start | |
Definition | The start of the period. The boundary is inclusive. |
Cardinality | 1...1 |
Type | dateTime |
Summary | True |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Invariants |
|
Mappings |
|
RelatedPerson.period.end | |
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
Invariants |
|
Mappings |
|
RelatedPerson.communication | |
Definition | A language which may be used to communicate with about the patient's health. |
Cardinality | 0...* |
Type | BackboneElement |
Requirements | If a related person does not speak the local language, interpreters may be required, so languages spoken and proficiency is an important things to keep track of both for patient and other persons of interest. |
Comments | If no language is specified, this implies that the default local language is spoken. If you need to convey proficiency for multiple modes, then you need multiple RelatedPerson.Communication associations. If the RelatedPerson does not speak the default local language, then the Interpreter Required Standard can be used to explicitly declare that an interpreter is required. |
Invariants |
|
Mappings |
|
RelatedPerson.communication.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
RelatedPerson.communication.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.communication.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
RelatedPerson.communication.language | |
Definition | The ISO-639-1 alpha 2 code in lower case for the language, optionally followed by a hyphen and the ISO-3166-1 alpha 2 code for the region in upper case; e.g. "en" for English, or "en-US" for American English versus "en-EN" for England English. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | A language which may be used to communicate with the related person about the patient's health. |
Requirements | Most systems in multilingual countries will want to convey language. Not all systems actually need the regional dialect. |
Comments | The structure aa-BB with this exact casing is one the most widely used notations for locale. However not all systems actually code this but instead have it as free text. Hence CodeableConcept instead of code as the data type. |
Invariants |
|
Mappings |
|
RelatedPerson.communication.preferred | |
Definition | Indicates whether or not the patient prefers this language (over other languages he masters up a certain level). |
Cardinality | 0...1 |
Type | boolean |
Requirements | People that master multiple languages up to certain level may prefer one or more, i.e. feel more confident in communicating in a particular language making other languages sort of a fall back method. |
Comments | This language is specifically identified for communicating healthcare information. |
Invariants |
|
Mappings |
|
Table View
RelatedPerson | .. | |
RelatedPerson.extension | Extension | .. |
RelatedPerson.extension | Extension | .. |
RelatedPerson.identifier | .. | |
RelatedPerson.identifier | EnglandIdentifierNHSNumber | ..1 |
RelatedPerson.patient | .. | |
RelatedPerson.patient.identifier | EnglandIdentifierNHSNumber | .. |
RelatedPerson.relationship | 1..3 | |
RelatedPerson.relationship.coding | 1..1 | |
RelatedPerson.relationship.coding.system | 1.. | |
RelatedPerson.relationship.coding.code | 1.. | |
RelatedPerson.relationship | ..2 | |
RelatedPerson.relationship.coding | .. | |
RelatedPerson.relationship.coding.system | .. | |
RelatedPerson.relationship | ..1 | |
RelatedPerson.relationship.coding | .. | |
RelatedPerson.relationship.coding.system | .. | |
RelatedPerson.relationship | ..1 | |
RelatedPerson.relationship.coding | .. | |
RelatedPerson.relationship.coding.system | .. | |
RelatedPerson.name | 1..1 | |
RelatedPerson.name.use | 1.. | |
RelatedPerson.name.period | .. | |
RelatedPerson.name.period.start | 1.. | |
RelatedPerson.telecom | .. | |
RelatedPerson.telecom.value | 1.. | |
RelatedPerson.telecom.use | 1.. | |
RelatedPerson.telecom.period | .. | |
RelatedPerson.telecom.period.start | 1.. | |
RelatedPerson.birthDate | .. | |
RelatedPerson.address | .. | |
RelatedPerson.address.extension | Extension | .. |
RelatedPerson.address.use | 1.. | |
RelatedPerson.address.period | .. | |
RelatedPerson.address.period.start | 1.. | |
RelatedPerson.period | .. | |
RelatedPerson.period.start | 1.. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="England-RelatedPerson-PDS" /> <url value="https://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-PDS" /> <version value="0.0.1-current" /> <name value="EnglandRelatedPersonPDS" /> <title value="England Related Person PDS" /> <status value="draft" /> <date value="2024-10-25T07:31:19+00:00" /> <publisher value="NHS England" /> <contact> <name value="NHS England" /> <telecom> <system value="email" /> <value value="interoperabilityteam@nhs.net" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="Based on [NHS England Confluence - Related Person Network - Physical Data Model - LPG](https://nhsd-confluence.digital.nhs.uk/display/DEMGRPH/Related+Person+Network+-+Physical+Data+Model+-+LPG#RelatedPersonNetworkPhysicalDataModelLPG-Appendix-FHIRRelatedPersonAPI-Example)" /> <purpose value="This documents requirement for NHS England PDS" /> <copyright value="Copyright © 2024+ NHS England Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="RelatedPerson" /> <baseDefinition value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson" /> <derivation value="constraint" /> <differential> <element id="RelatedPerson.extension:ContactRank"> <path value="RelatedPerson.extension" /> <sliceName value="ContactRank" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank" /> </type> </element> <element id="RelatedPerson.extension:interpreterRequired"> <path value="RelatedPerson.extension" /> <sliceName value="interpreterRequired" /> <type> <code value="Extension" /> <profile value="http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" /> </type> </element> <element id="RelatedPerson.identifier"> <path value="RelatedPerson.identifier" /> <slicing> <discriminator> <type value="pattern" /> <path value="system" /> </discriminator> <rules value="closed" /> </slicing> <mustSupport value="true" /> </element> <element id="RelatedPerson.identifier:NHSNumber"> <path value="RelatedPerson.identifier" /> <sliceName value="NHSNumber" /> <max value="1" /> <type> <code value="Identifier" /> <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-NHS-Number" /> </type> </element> <element id="RelatedPerson.patient.identifier"> <path value="RelatedPerson.patient.identifier" /> <type> <code value="Identifier" /> <profile value="https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-NHS-Number" /> </type> </element> <element id="RelatedPerson.relationship"> <path value="RelatedPerson.relationship" /> <slicing> <discriminator> <type value="pattern" /> <path value="coding.system" /> </discriminator> <rules value="openAtEnd" /> </slicing> <min value="1" /> <max value="3" /> </element> <element id="RelatedPerson.relationship.coding"> <path value="RelatedPerson.relationship.coding" /> <min value="1" /> <max value="1" /> <binding> <strength value="preferred" /> <valueSet value="https://fhir.nhs.uk/England/ValueSet/England-PDSRelationshipType" /> </binding> </element> <element id="RelatedPerson.relationship.coding.system"> <path value="RelatedPerson.relationship.coding.system" /> <min value="1" /> </element> <element id="RelatedPerson.relationship.coding.code"> <path value="RelatedPerson.relationship.coding.code" /> <min value="1" /> </element> <element id="RelatedPerson.relationship:Role"> <path value="RelatedPerson.relationship" /> <sliceName value="Role" /> <max value="2" /> </element> <element id="RelatedPerson.relationship:Role.coding.system"> <path value="RelatedPerson.relationship.coding.system" /> <patternUri value="https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole" /> </element> <element id="RelatedPerson.relationship:Type"> <path value="RelatedPerson.relationship" /> <sliceName value="Type" /> <max value="1" /> </element> <element id="RelatedPerson.relationship:Type.coding.system"> <path value="RelatedPerson.relationship.coding.system" /> <patternUri value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" /> </element> <element id="RelatedPerson.relationship:NextOfKin"> <path value="RelatedPerson.relationship" /> <sliceName value="NextOfKin" /> <max value="1" /> </element> <element id="RelatedPerson.relationship:NextOfKin.coding.system"> <path value="RelatedPerson.relationship.coding.system" /> <patternUri value="http://terminology.hl7.org/CodeSystem/v2-0131" /> </element> <element id="RelatedPerson.name"> <path value="RelatedPerson.name" /> <min value="1" /> <max value="1" /> </element> <element id="RelatedPerson.name.use"> <path value="RelatedPerson.name.use" /> <min value="1" /> </element> <element id="RelatedPerson.name.period.start"> <path value="RelatedPerson.name.period.start" /> <min value="1" /> </element> <element id="RelatedPerson.telecom.value"> <path value="RelatedPerson.telecom.value" /> <min value="1" /> </element> <element id="RelatedPerson.telecom.use"> <path value="RelatedPerson.telecom.use" /> <min value="1" /> </element> <element id="RelatedPerson.telecom.period.start"> <path value="RelatedPerson.telecom.period.start" /> <min value="1" /> </element> <element id="RelatedPerson.birthDate"> <path value="RelatedPerson.birthDate" /> <mustSupport value="true" /> </element> <element id="RelatedPerson.address.extension:AddressKey"> <path value="RelatedPerson.address.extension" /> <sliceName value="AddressKey" /> <type> <code value="Extension" /> <profile value="https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey" /> </type> </element> <element id="RelatedPerson.address.use"> <path value="RelatedPerson.address.use" /> <min value="1" /> </element> <element id="RelatedPerson.address.period.start"> <path value="RelatedPerson.address.period.start" /> <min value="1" /> </element> <element id="RelatedPerson.period.start"> <path value="RelatedPerson.period.start" /> <min value="1" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "England-RelatedPerson-PDS", "url": "https://fhir.nhs.uk/England/StructureDefinition/England-RelatedPerson-PDS", "version": "0.0.1-current", "name": "EnglandRelatedPersonPDS", "title": "England Related Person PDS", "status": "draft", "date": "10/25/2024 07:31:19", "publisher": "NHS England", "contact": [ { "name": "NHS England", "telecom": [ { "system": "email", "value": "interoperabilityteam@nhs.net", "use": "work", "rank": 1 } ] } ], "description": "Based on [NHS England Confluence - Related Person Network - Physical Data Model - LPG](https://nhsd-confluence.digital.nhs.uk/display/DEMGRPH/Related+Person+Network+-+Physical+Data+Model+-+LPG#RelatedPersonNetworkPhysicalDataModelLPG-Appendix-FHIRRelatedPersonAPI-Example)", "purpose": "This documents requirement for NHS England PDS", "copyright": "Copyright © 2024+ NHS England Licensed under the Apache License, Version 2.0 (the \\\"License\\\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \\\"AS IS\\\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "RelatedPerson", "baseDefinition": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-RelatedPerson", "derivation": "constraint", "differential": { "element": [ { "id": "RelatedPerson.extension:ContactRank", "path": "RelatedPerson.extension", "sliceName": "ContactRank", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-ContactRank" ] } ] }, { "id": "RelatedPerson.extension:interpreterRequired", "path": "RelatedPerson.extension", "sliceName": "interpreterRequired", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/patient-interpreterRequired" ] } ] }, { "id": "RelatedPerson.identifier", "path": "RelatedPerson.identifier", "slicing": { "discriminator": [ { "type": "pattern", "path": "system" } ], "rules": "closed" }, "mustSupport": true }, { "id": "RelatedPerson.identifier:NHSNumber", "path": "RelatedPerson.identifier", "sliceName": "NHSNumber", "max": "1", "type": [ { "code": "Identifier", "profile": [ "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-NHS-Number" ] } ] }, { "id": "RelatedPerson.patient.identifier", "path": "RelatedPerson.patient.identifier", "type": [ { "code": "Identifier", "profile": [ "https://fhir.nhs.uk/England/StructureDefinition/England-Identifier-NHS-Number" ] } ] }, { "id": "RelatedPerson.relationship", "path": "RelatedPerson.relationship", "slicing": { "discriminator": [ { "type": "pattern", "path": "coding.system" } ], "rules": "openAtEnd" }, "min": 1, "max": "3" }, { "id": "RelatedPerson.relationship.coding", "path": "RelatedPerson.relationship.coding", "min": 1, "max": "1", "binding": { "strength": "preferred", "valueSet": "https://fhir.nhs.uk/England/ValueSet/England-PDSRelationshipType" } }, { "id": "RelatedPerson.relationship.coding.system", "path": "RelatedPerson.relationship.coding.system", "min": 1 }, { "id": "RelatedPerson.relationship.coding.code", "path": "RelatedPerson.relationship.coding.code", "min": 1 }, { "id": "RelatedPerson.relationship:Role", "path": "RelatedPerson.relationship", "sliceName": "Role", "max": "2" }, { "id": "RelatedPerson.relationship:Role.coding.system", "path": "RelatedPerson.relationship.coding.system", "patternUri": "https://fhir.hl7.org.uk/CodeSystem/UKCore-AdditionalPersonRelationshipRole" }, { "id": "RelatedPerson.relationship:Type", "path": "RelatedPerson.relationship", "sliceName": "Type", "max": "1" }, { "id": "RelatedPerson.relationship:Type.coding.system", "path": "RelatedPerson.relationship.coding.system", "patternUri": "http://terminology.hl7.org/CodeSystem/v3-RoleCode" }, { "id": "RelatedPerson.relationship:NextOfKin", "path": "RelatedPerson.relationship", "sliceName": "NextOfKin", "max": "1" }, { "id": "RelatedPerson.relationship:NextOfKin.coding.system", "path": "RelatedPerson.relationship.coding.system", "patternUri": "http://terminology.hl7.org/CodeSystem/v2-0131" }, { "id": "RelatedPerson.name", "path": "RelatedPerson.name", "min": 1, "max": "1" }, { "id": "RelatedPerson.name.use", "path": "RelatedPerson.name.use", "min": 1 }, { "id": "RelatedPerson.name.period.start", "path": "RelatedPerson.name.period.start", "min": 1 }, { "id": "RelatedPerson.telecom.value", "path": "RelatedPerson.telecom.value", "min": 1 }, { "id": "RelatedPerson.telecom.use", "path": "RelatedPerson.telecom.use", "min": 1 }, { "id": "RelatedPerson.telecom.period.start", "path": "RelatedPerson.telecom.period.start", "min": 1 }, { "id": "RelatedPerson.birthDate", "path": "RelatedPerson.birthDate", "mustSupport": true }, { "id": "RelatedPerson.address.extension:AddressKey", "path": "RelatedPerson.address.extension", "sliceName": "AddressKey", "type": [ { "code": "Extension", "profile": [ "https://fhir.hl7.org.uk/StructureDefinition/Extension-UKCore-AddressKey" ] } ] }, { "id": "RelatedPerson.address.use", "path": "RelatedPerson.address.use", "min": 1 }, { "id": "RelatedPerson.address.period.start", "path": "RelatedPerson.address.period.start", "min": 1 }, { "id": "RelatedPerson.period.start", "path": "RelatedPerson.period.start", "min": 1 } ] } }
Feedback
Click here to:Report issue for England-RelatedPerson-PDS, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
StructureDefinition UK-Core-Provenance
Detailed Descriptions
Provenance | |
Definition | Provenance of a resource is a record that describes entities and processes involved in producing and delivering or otherwise influencing that resource. Provenance provides a critical foundation for assessing authenticity, enabling trust, and allowing reproducibility. Provenance assertions are a form of contextual metadata and can themselves become important records with their own provenance. Provenance statement indicates clinical significance in terms of confidence in authenticity, reliability, and trustworthiness, integrity, and stage in lifecycle (e.g. Document Completion - has the artifact been legally authenticated), all of which may impact security, privacy, and trust policies. |
Cardinality | 0...* |
Alias | History, Event, Activity |
Comments | Some parties may be duplicated between the target resource and its provenance. For instance, the prescriber is usually (but not always) the author of the prescription resource. This resource is defined with close consideration for W3C Provenance. |
Invariants |
|
Mappings |
|
Provenance.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Provenance.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Provenance.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Provenance.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Provenance.text | |
Definition | A human-readable narrative that contains a summary of the resource and can 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. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Provenance.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Provenance.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Provenance.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Provenance.target | |
Definition | The Reference(s) that were generated or updated by the activity described in this resource. A provenance can point to more than one target if multiple resources were created/updated by the same activity. |
Cardinality | 1...* |
Type | Reference(Resource) |
Must Support | True |
Summary | True |
Comments | Target references are usually version specific, but might not be, if a version has not been assigned or if the provenance information is part of the set of resources being maintained (i.e. a document). When using the RESTful API, the identity of the resource might not be known (especially not the version specific one); the client may either submit the resource first, and then the provenance, or it may submit both using a single transaction. See the notes on transaction for further discussion. |
Invariants |
|
Mappings |
|
Provenance.occurred[x] | |
Definition | The period during which the activity occurred. |
Cardinality | 0...1 |
Type | Period |
Comments | The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time. |
Invariants |
|
Mappings |
|
Provenance.recorded | |
Definition | The instant of time at which the activity was recorded. |
Cardinality | 1...1 |
Type | instant |
Must Support | True |
Summary | True |
Comments | This can be a little different from the time stamp on the resource if there is a delay between recording the event and updating the provenance and target resource. |
Invariants |
|
Mappings |
|
Provenance.policy | |
Definition | Policy or plan the activity was defined by. Typically, a single activity may have multiple applicable policy documents, such as patient consent, guarantor funding, etc. |
Cardinality | 0...* |
Type | uri |
Comments | For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element. |
Invariants |
|
Mappings |
|
Provenance.location | |
Definition | Where the activity occurred, if relevant. |
Cardinality | 0...1 |
Type | Reference(Location) |
Invariants |
|
Mappings |
|
Provenance.reason | |
Definition | The reason that the activity was taking place. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The reason the activity took place. |
Invariants |
|
Mappings |
|
Provenance.activity | |
Definition | An activity is something that occurs over a period of time and acts upon or with entities; it may include consuming, processing, transforming, modifying, relocating, using, or generating entities. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The activity that took place. |
Invariants |
|
Mappings |
|
Provenance.agent | |
Definition | An actor taking a role in an activity for which it can be assigned some degree of responsibility for the activity taking place. |
Cardinality | 1...* |
Type | BackboneElement |
Must Support | True |
Requirements | An agent can be a person, an organization, software, device, or other entities that may be ascribed responsibility. |
Comments | Several agents may be associated (i.e. has some responsibility for an activity) with an activity and vice-versa. |
Invariants |
|
Mappings |
|
Provenance.agent.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Provenance.agent.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Provenance.agent.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Provenance.agent.type | |
Definition | The participation the agent had with respect to the activity. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | The type of participation that a provenance agent played with respect to the activity. |
Summary | True |
Comments | For example: author, performer, enterer, attester, etc. |
Invariants |
|
Mappings |
|
Provenance.agent.role | |
Definition | The function of the agent with respect to the activity. The security role enabling the agent with respect to the activity. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The role that a provenance agent played with respect to the activity. |
Comments | For example: doctor, nurse, clerk, etc. |
Invariants |
|
Mappings |
|
Provenance.agent.who | |
Definition | The individual, device or organization that participated in the event. |
Cardinality | 1...1 |
Type | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
Summary | True |
Comments | whoIdentity should be used when the agent is not a Resource type. |
Invariants |
|
Mappings |
|
Provenance.agent.onBehalfOf | |
Definition | The individual, device, or organization for whom the change was made. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) |
Comments | onBehalfOfIdentity should be used when the agent is not a Resource type. |
Invariants |
|
Mappings |
|
Provenance.entity | |
Definition | An entity used in this activity. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Mappings |
|
Provenance.entity.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Provenance.entity.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Provenance.entity.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Provenance.entity.role | |
Definition | How the entity was used during the activity. |
Cardinality | 1...1 |
Type | code |
Binding | How an entity was used in an activity. |
Summary | True |
Invariants |
|
Mappings |
|
Provenance.entity.what | |
Definition | Identity of the Entity used. May be a logical or physical uri and maybe absolute or relative. |
Cardinality | 1...1 |
Type | Reference(Resource) |
Summary | True |
Comments | whatIdentity should be used for entities that are not a Resource type. |
Invariants |
|
Mappings |
|
Provenance.entity.agent | |
Definition | The entity is attributed to an agent to express the agent's responsibility for that entity, possibly along with other agents. This description can be understood as shorthand for saying that the agent was responsible for the activity which generated the entity. |
Cardinality | 0...* |
Type | see (agent) |
Comments | A usecase where one Provenance.entity.agent is used where the Entity that was used in the creation/updating of the Target, is not in the context of the same custodianship as the Target, and thus the meaning of Provenance.entity.agent is to say that the entity referenced is managed elsewhere and that this Agent provided access to it. This would be similar to where the Entity being referenced is managed outside FHIR, such as through HL7 v2, v3, or XDS. This might be where the Entity being referenced is managed in another FHIR resource server. Thus it explains the Provenance of that Entity's use in the context of this Provenance activity. |
Invariants |
|
Mappings |
|
Provenance.signature | |
Definition | A digital signature on the target Reference(s). The signer should match a Provenance.agent. The purpose of the signature is indicated. |
Cardinality | 0...* |
Type | Signature |
Must Support | True |
Invariants |
|
Mappings |
|
Table View
Provenance | .. | |
Provenance.target | .. | |
Provenance.recorded | .. | |
Provenance.agent | .. | |
Provenance.signature | .. |
XML View
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="UKCore-Provenance" /> <url value="https://fhir.hl7.org.uk/StructureDefinition/UKCore-Provenance" /> <version value="1.2.0" /> <name value="UKCoreProvenance" /> <title value="UK Core Provenance" /> <status value="draft" /> <date value="2023-12-12" /> <publisher value="HL7 UK" /> <contact> <name value="HL7 UK" /> <telecom> <system value="email" /> <value value="ukcore@hl7.org.uk" /> <use value="work" /> <rank value="1" /> </telecom> </contact> <description value="This profile defines the UK constraints and extensions on the International FHIR resource [Provenance](https://hl7.org/fhir/R4/Provenance.html)." /> <purpose value="The Provenance resource tracks information about the activity that created, revised, deleted, or signed a version of a resource, describing the entities and agents involved." /> <copyright value="Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html." /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Provenance" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Provenance" /> <derivation value="constraint" /> <differential> <element id="Provenance.target"> <path value="Provenance.target" /> <mustSupport value="true" /> </element> <element id="Provenance.recorded"> <path value="Provenance.recorded" /> <mustSupport value="true" /> </element> <element id="Provenance.agent"> <path value="Provenance.agent" /> <mustSupport value="true" /> </element> <element id="Provenance.signature"> <path value="Provenance.signature" /> <mustSupport value="true" /> </element> </differential> </StructureDefinition>
JSON View
{ "resourceType": "StructureDefinition", "id": "UKCore-Provenance", "url": "https://fhir.hl7.org.uk/StructureDefinition/UKCore-Provenance", "version": "1.2.0", "name": "UKCoreProvenance", "title": "UK Core Provenance", "status": "draft", "date": "2023-12-12", "publisher": "HL7 UK", "contact": [ { "name": "HL7 UK", "telecom": [ { "system": "email", "value": "ukcore@hl7.org.uk", "use": "work", "rank": 1 } ] } ], "description": "This profile defines the UK constraints and extensions on the International FHIR resource [Provenance](https://hl7.org/fhir/R4/Provenance.html).", "purpose": "The Provenance resource tracks information about the activity that created, revised, deleted, or signed a version of a resource, describing the entities and agents involved.", "copyright": "Copyright © 2021+ HL7 UK Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. HL7® FHIR® standard Copyright © 2011+ HL7 The HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at https://www.hl7.org/fhir/license.html.", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Provenance", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Provenance", "derivation": "constraint", "differential": { "element": [ { "id": "Provenance.target", "path": "Provenance.target", "mustSupport": true }, { "id": "Provenance.recorded", "path": "Provenance.recorded", "mustSupport": true }, { "id": "Provenance.agent", "path": "Provenance.agent", "mustSupport": true }, { "id": "Provenance.signature", "path": "Provenance.signature", "mustSupport": true } ] } }
Feedback
Click here to:Report issue for UK-Core-Provenance, , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,