Left: | US Core RelatedPerson Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson) |
Right: | PA Related Person (http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-relatedperson) |
Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson' vs 'http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-relatedperson' |
Error | StructureDefinition.version | Values for version differ: '7.0.0-ballot' vs '1.0.1' |
Information | StructureDefinition.name | Values for name differ: 'USCoreRelatedPersonProfile' vs 'PARelatedPerson' |
Information | StructureDefinition.title | Values for title differ: 'US Core RelatedPerson Profile' vs 'PA Related Person' |
Information | StructureDefinition.date | Values for date differ: '2023-10-17' vs '2024-03-12T17:26:10+00:00' |
Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International / Cross-Group Projects' vs 'HL7 International / Patient Care' |
Information | StructureDefinition.definition | Values for definition differ: '\-' vs 'A profile on RelatedPerson that mirrors the requirements of future US Core versions' |
Information | RelatedPerson.implicitRules | Element maximum cardinalities differ: '1' vs '0' |
Information | StructureDefinition.short | Values for short differ: 'Extensions that cannot be ignored' vs 'Extension' |
Information | StructureDefinition.definition | Values for definition differ: '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).' vs 'An Extension' |
Information | RelatedPerson.modifierExtension | Element maximum cardinalities differ: '2147483647' vs '0' |
Information | RelatedPerson.active | Element minimum cardinalities differ: '1' vs '0' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/RelatedPerson | ||
copyright | Used by permission of HL7 International, all rights reserved Creative Commons License |
| |
date | 2023-10-17 | 2024-03-12T17:26:10+00:00 |
|
description | This profile sets minimum expectations for the RelatedPerson resource to record, search, and fetch basic administrative information about persons with a legal or familial relationship to a patient. It identifies which core elements, extensions, vocabularies, and value sets **SHALL** be present in the resource and constrains the way the elements are used when using this profile. It provides the floor for standards development for specific use cases. | A profile on RelatedPerson that mirrors the requirements of future US Core versions |
|
experimental | |||
fhirVersion | 4.0.1 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | resource | ||
name | USCoreRelatedPersonProfile | PARelatedPerson |
|
publisher | HL7 International / Cross-Group Projects | HL7 International / Patient Care |
|
purpose | |||
status | active | ||
title | US Core RelatedPerson Profile | PA Related Person |
|
type | RelatedPerson | ||
url | http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson | http://hl7.org/fhir/us/physical-activity/StructureDefinition/pa-relatedperson |
|
version | 7.0.0-ballot | 1.0.1 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
RelatedPerson | C | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care us-core-14: Either a name or a relationship SHALL be provided (or both) | C | 0..* | RelatedPerson | A person that is related to a patient, but who is not a direct target of care us-core-14: Either a name or a relationship SHALL be provided (or both) | |||||||||
id | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
meta | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..0 |
| ||||||||||
language | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..0 |
| ||||||||||
identifier | Σ | 0..* | Identifier | A human identifier for this person | Σ | 0..* | Identifier | A human identifier for this person | |||||||||
active | ?!SΣ | 1..1 | boolean | Whether this related person's record is in active use | ?!SΣ | 0..1 | boolean | Whether this related person's record is in active use |
| ||||||||
patient | SΣ | 1..1 | Reference(US Core Patient Profile) | The patient this person is related to | SΣ | 1..1 | Reference(US Core Patient Profile) | The patient this person is related to | |||||||||
relationship | SΣC | 0..* | CodeableConcept | The nature of the relationship Binding: ?? (preferred): The nature of the relationship between a patient and the related person. | SΣC | 0..* | CodeableConcept | The nature of the relationship Binding: ?? (preferred): The nature of the relationship between a patient and the related person. | |||||||||
id | 0..1 | string | Unique id for inter-element referencing |
| |||||||||||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| |||||||||||||
coding | Σ | 0..* | Coding | Code defined by a terminology system |
| ||||||||||||
text | SΣ | 1..1 | string | Plain text representation of the concept |
| ||||||||||||
name | SΣC | 0..* | HumanName | A name associated with the person | SΣC | 0..* | HumanName | A name associated with the person pa-relatedperson-1: At least one of given and family must exist | |||||||||
id | 0..1 | string | Unique id for inter-element referencing |
| |||||||||||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| |||||||||||||
use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: ?? (required): The use of a human name. |
| ||||||||||||
text | Σ | 0..1 | string | Text representation of the full name |
| ||||||||||||
family | SΣ | 0..1 | string | Family name (often called 'Surname') |
| ||||||||||||
given | SΣ | 0..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name |
| ||||||||||||
prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name |
| ||||||||||||
suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name |
| ||||||||||||
period | Σ | 0..1 | Period | Time period when name was/is in use |
| ||||||||||||
telecom | SΣ | 0..* | ContactPoint | A contact detail for the person | SΣ | 0..* | ContactPoint | A contact detail for the person | |||||||||
id | 0..1 | string | Unique id for inter-element referencing |
| |||||||||||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| |||||||||||||
system | SΣC | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ?? (required): Telecommunications form for contact point. |
| ||||||||||||
value | SΣ | 1..1 | string | The actual contact point details |
| ||||||||||||
use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ?? (required): Use of contact point. |
| ||||||||||||
rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) |
| ||||||||||||
period | Σ | 0..1 | Period | Time period when the contact point was/is in use |
| ||||||||||||
gender | Σ | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. | Σ | 0..1 | code | male | female | other | unknown Binding: ?? (required): The gender of a person used for administrative purposes. | |||||||||
birthDate | Σ | 0..1 | date | The date on which the related person was born | Σ | 0..1 | date | The date on which the related person was born | |||||||||
address | SΣ | 0..* | Address | Address where the related person can be contacted or visited | SΣ | 0..* | Address | Address where the related person can be contacted or visited | |||||||||
id | 0..1 | string | Unique id for inter-element referencing |
| |||||||||||||
Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| |||||||||||||
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: ?? (required): The use of an address. Example General: home |
| ||||||||||||
type | Σ | 0..1 | code | postal | physical | both Binding: ?? (required): The type of an address (physical / postal). Example General: both |
| ||||||||||||
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
| ||||||||||||
line | SΣ | 0..* | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
| ||||||||||||
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
| ||||||||||||
district | Σ | 0..1 | string | District name (aka county) Example General: Madison |
| ||||||||||||
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) |
| ||||||||||||
postalCode | SΣ | 0..1 | string | Postal code for area Example General: 9132 |
| ||||||||||||
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
| ||||||||||||
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23","end":"2010-07-01"} |
| ||||||||||||
photo | 0..* | Attachment | Image of the person | 0..* | Attachment | Image of the person | |||||||||||
period | 0..1 | Period | Period of time that this relationship is considered valid | 0..1 | Period | Period of time that this relationship is considered valid | |||||||||||
communication | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | 0..* | BackboneElement | A language which may be used to communicate with about the patient's health | |||||||||||
id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
language | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: ?? (preferred): A human language.
| 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: ?? (preferred): A human language.
| |||||||||||
preferred | 0..1 | boolean | Language preference indicator | 0..1 | boolean | Language preference indicator | |||||||||||
Documentation for this format |