RelatedPerson
The RelatedPerson resource is used for the creation of a policyholder. In the case of a co-insured person, the owner of the insurance must be created.
| RelatedPerson | C | RelatedPerson | There are no (further) constraints on this element Element idRelatedPersonShort description A person that is related to a patient, but who is not a direct target of care DefinitionInformation about a person that is involved in the care for a patient, but who is not the target of healthcare, nor has a formal responsibility in the care process.
| |||
| id | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.idShort description Logical id of this artifact DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||
| meta | Σ | 0..1 | Meta | There are no (further) constraints on this element Element idRelatedPerson.metaShort description Metadata about the resource DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
| ||
| implicitRules | Σ ?! | 0..0 | uri | There are no (further) constraints on this element Element idRelatedPerson.implicitRulesShort description A set of rules under which this content was created DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. 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.
| ||
| language | 0..0 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.languageShort description Language of the resource content DefinitionThe base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). A human language.
| |||
| text | 0..1 | Narrative | There are no (further) constraints on this element Element idRelatedPerson.textShort description Text summary of the resource, for human interpretation Alternate namesnarrative, html, xhtml, display DefinitionA human-readable narrative that contains a summary of the resource and 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. 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.
| |||
| contained | 0..0 | Resource | There are no (further) constraints on this element Element idRelatedPerson.containedShort description Contained, inline Resources Alternate namesinline resources, anonymous resources, contained resources DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. 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.
| ||
| modifierExtension | ?! C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.modifierExtensionShort description Extensions that cannot be ignored Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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). 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. 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.
| ||
| identifier | Σ | 0..1 | Identifier | There are no (further) constraints on this element Element idRelatedPerson.identifierShort description A human identifier for this person DefinitionIdentifier for a person within a particular scope. People are known by a variety of ids. Some institutions maintain several, and most collect identifiers for exchange with other organizations concerning the patient. Examples are national person identifier and local identifier.
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.identifier.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.identifier.useShort description usual | official | temp | secondary | old (If known) DefinitionThe purpose of this identifier. Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. Identifies the purpose for this identifier, if known .
| ||
| type | Σ | 0..1 | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.identifier.typeShort description Description of identifier DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose. Allows users to make use of identifiers when the identifier system is not known. This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Identifier Type Codes (extensible) Constraints
| ||
| system | Σ | 1..1 | uri | There are no (further) constraints on this element Element idRelatedPerson.identifier.systemShort description The namespace for the identifier value DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique. There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. Identifier.system is always case sensitive.
General http://www.acme.com/identifiers/patientMappings
| ||
| value | Σ | 1..1 | string | There are no (further) constraints on this element Element idRelatedPerson.identifier.valueShort description The value that is unique DefinitionThe portion of the identifier typically relevant to the user and which is unique within the context of the system. If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
General 123456Mappings
| ||
| period | Σ | 0..1 | Period | There are no (further) constraints on this element Element idRelatedPerson.identifier.periodShort description Time period when id is/was valid for use DefinitionTime period during which identifier is/was valid for use.
| ||
| assigner | Σ | 0..1 | Reference(Organization) | There are no (further) constraints on this element Element idRelatedPerson.identifier.assignerShort description Organization that issued id (may be just text) DefinitionOrganization that issued/manages the identifier. The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
| ||
| active | Σ ?! | 0..1 | boolean | There are no (further) constraints on this element Element idRelatedPerson.activeShort description Whether this related person's record is in active use DefinitionWhether this related person record is in active use. Need to be able to mark a related person record as not to be used, such as if it was created in error. This element is labeled as a modifier because it may be used to mark that the resource was created in error. This resource is generally assumed to be active if no value is provided for the active element
| ||
| patient | Σ | 1..1 | Reference(Patient) | There are no (further) constraints on this element Element idRelatedPerson.patientShort description The patient this person is related to DefinitionThe patient this person is related to. We need to know which patient this RelatedPerson is related to.
| ||
| relationship | Σ | 0..* | CodeableConceptBinding | There are no (further) constraints on this element Element idRelatedPerson.relationshipShort description The nature of the relationship DefinitionThe nature of the relationship between a patient and the related person. We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person. The nature of the relationship between a patient and the related person. PatientRelationshipType (preferred) Constraints
| ||
| name | Σ | 0..* | HumanName | Element idRelatedPerson.nameShort description A name associated with the person DefinitionA name associated with the person. Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.
| ||
| id | 0..0 | string | There are no (further) constraints on this element Element idRelatedPerson.name.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |||
| extension | C | 0..* | Extension | There are no (further) constraints on this element Element idRelatedPerson.name.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the element. 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
| ||
| use | Σ ?! | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.name.useShort description usual | official | temp | nickname | anonymous | old | maiden DefinitionIdentifies the purpose for this name. Allows the appropriate name for a particular context of use to be selected from among a set of names. Applications can assume that a name is current unless it explicitly says that it is temporary or old. The use of a human name.
| ||
| text | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.name.textShort description Text representation of the full name DefinitionSpecifies 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. A renderable, unencoded form. 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.
| ||
| family | Σ | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.name.familyShort description Family name (often called 'Surname') Alternate namessurname DefinitionThe part of a name that links to the genealogy. In some cultures (e.g. Eritrea) the family name of a son is the first name of his father. Family Name may be decomposed into specific parts using extensions (de, nl, es related cultures).
| ||
| given | Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.name.givenShort description Given names (not always 'first'). Includes middle names Alternate namesfirst name, middle name DefinitionGiven name. If only initials are recorded, they may be used in place of the full name 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.
| ||
| prefix | Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.name.prefixShort description Parts that come before the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the start of the name.
| ||
| suffix | Σ | 0..* | string | There are no (further) constraints on this element Element idRelatedPerson.name.suffixShort description Parts that come after the name DefinitionPart of the name that is acquired as a title due to academic, legal, employment or nobility status, etc. and that appears at the end of the name.
| ||
| period | Σ | 0..0 | Period | There are no (further) constraints on this element Element idRelatedPerson.name.periodShort description Time period when name was/is in use DefinitionIndicates the period of time when this name was valid for the named person. Allows names to be placed in historical context.
| ||
| telecom | Σ C | 0..* | UContactPoint | Element idRelatedPerson.telecomShort description Details of a Technology mediated contact point (phone, fax, email, etc.) DefinitionDetails for all kinds of technology mediated contact points for a person or organization, including telephone, email, etc. People have (primary) ways to contact them in some way such as phone, email. Person may have multiple ways to be contacted with different uses or applicable periods. May need to have options for contacting the person urgently, and also to help with identification. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| gender | Σ | 0..1 | codeBinding | There are no (further) constraints on this element Element idRelatedPerson.genderShort description male | female | other | unknown DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes. Needed for identification of the person, in combination with (at least) name and birth date. The gender of a person used for administrative purposes. AdministrativeGender (required) Constraints
| ||
| id | 0..1 | string | There are no (further) constraints on this element Element idRelatedPerson.gender.idShort description xml:id (or equivalent in JSON) Definitionunique id for the element within a resource (for internal references) | |||
| extension | C | 0..* | Extension | Element idRelatedPerson.gender.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. 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. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Unordered, Open, by url(Value) Constraints
| ||
| myExtension | C | 0..* | Extension(Coding) | Element idRelatedPerson.gender.extension:myExtensionShort description Optional Extensions Element Alternate namesextensions, user content DefinitionOptional Extension Element - found in all resources. 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. http://fhir.de/StructureDefinition/gender-amtlich-de ConditionsThe cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| value | 0..1 | System.String | There are no (further) constraints on this element Element idRelatedPerson.gender.valueShort description Primitive value for code DefinitionPrimitive value for code System.String | |||
| birthDate | Σ | 0..1 | date | Element idRelatedPerson.birthDateShort description The date on which the related person was born DefinitionThe date on which the related person was born.
| ||
| address | Σ | 0..* | UAddress | Element idRelatedPerson.addressShort description An address expressed using postal conventions (as opposed to GPS or other location definition formats) DefinitionAn address expressed using postal conventions (as opposed to GPS or other location definition formats). This data type may be used to convey addresses for use in delivering mail as well as for visiting locations which might not be valid for mail delivery. There are a variety of postal address formats defined around the world. Need to keep track where the related person can be contacted per postal mail or visited. Note: address is intended to describe postal addresses for administrative purposes, not to describe absolute geographical coordinates. Postal addresses are often used as proxies for physical locations (also see the Location resource). The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| ||
| photo | 0..0 | Attachment | There are no (further) constraints on this element Element idRelatedPerson.photoShort description Image of the person DefinitionImage of the person. Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.
| |||
| period | 0..0 | Period | There are no (further) constraints on this element Element idRelatedPerson.periodShort description Period of time that this relationship is considered valid DefinitionThe period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
| |||
| communication | 0..0 | BackboneElement | There are no (further) constraints on this element Element idRelatedPerson.communicationShort description A language which may be used to communicate with about the patient's health DefinitionA language which may be used to communicate with about the patient's health. 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. 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.
|
Example JSON
Example data record:
Example XML
Example data record: