This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions
Patient Administration Work Group | Maturity Level: N/A | Standards Status: Informative | Compartments: Patient, RelatedPerson |
Raw Turtle (+ also see Turtle/RDF Format Specification)
StructureDefinition for personalrelationship
@prefix fhir: <http://hl7.org/fhir/> . @prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> . # - resource ------------------------------------------------------------------- [] a fhir:StructureDefinition ; fhir:id [ fhir:v "PersonalRelationship"] ; fhir:meta [ fhir:lastUpdated [ fhir:v "2024-11-11T07:23:23.182+00:00" ] ] ; fhir:text [ fhir:status [ fhir:v "generated" ] ] ; fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status" ] ; fhir:value [ fhir:v "draft" ] ] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" ] ; fhir:value [ fhir:v "pa" ] ] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm" ] ; fhir:value [ fhir:v "0" ] ] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category" ] ; fhir:value [ fhir:v "patient" ] ] ) ; fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/PersonalRelationship"], [ fhir:v "http://hl7.org/fhir/StructureDefinition/PersonalRelationship"] ; fhir:version [ fhir:v "6.0.0-ballot2"], [ fhir:v "6.0.0-ballot2"] ; fhir:name [ fhir:v "PersonalRelationship"], [ fhir:v "PersonalRelationship"] ; fhir:status [ fhir:v "draft"], [ fhir:v "draft"] ; fhir:experimental [ fhir:v "true"], [ fhir:v "true"] ; fhir:date [ fhir:v "2024-11-11T07:23:23+00:00"], [ fhir:v "2024-11-11T07:23:23+00:00"] ; fhir:publisher [ fhir:v "HL7 International / Patient Administration"], [ fhir:v "HL7 International / Patient Administration"] ; fhir:contact ( [ fhir:telecom ( [ fhir:system [ fhir:v "url" ] ; fhir:value [ fhir:v "http://www.hl7.org/Special/committees/fiwg" ] ] ) ] [ fhir:telecom ( [ fhir:system [ fhir:v "url" ] ; fhir:value [ fhir:v "http://www.hl7.org/Special/committees/pafm" ] ] ) ] [ fhir:telecom ( [ fhir:system [ fhir:v "url" ] ; fhir:value [ fhir:v "http://www.hl7.org/Special/committees/fiwg" ] ] ) ] [ fhir:telecom ( [ fhir:system [ fhir:v "url" ] ; fhir:value [ fhir:v "http://www.hl7.org/Special/committees/pafm" ] ] ) ] ) ; fhir:description [ fhir:v "Details about the relationship between 2 individuals."], [ fhir:v "Details about the relationship between 2 individuals."] ; fhir:jurisdiction ( [ fhir:coding ( [ fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ; fhir:code [ fhir:v "001" ] ; fhir:display [ fhir:v "World" ] ] ) ] [ fhir:coding ( [ fhir:system [ fhir:v "http://unstats.un.org/unsd/methods/m49/m49.htm" ] ; fhir:code [ fhir:v "001" ] ; fhir:display [ fhir:v "World" ] ] ) ] ) ; fhir:purpose [ fhir:v "Need to track relationships between individuals along with the attributes of that relationship such as:\r* Represent relationship between two members\r* Represent the certainty of the relationship\r* Represent the temporal nature of the relationship (e.g., father/daughter is mostly persistent, but resident in household is very transient).\r* Represent the role of the person within a group (e.g., the head of the household is the decision maker)"], [ fhir:v "Need to track relationships between individuals along with the attributes of that relationship such as:\r* Represent relationship between two members\r* Represent the certainty of the relationship\r* Represent the temporal nature of the relationship (e.g., father/daughter is mostly persistent, but resident in household is very transient).\r* Represent the role of the person within a group (e.g., the head of the household is the decision maker)"] ; fhir:fhirVersion [ fhir:v "6.0.0-ballot2"] ; fhir:mapping ( [ fhir:identity [ fhir:v "w5" ] ; fhir:uri [ fhir:v "http://hl7.org/fhir/fivews" ] ; fhir:name [ fhir:v "FiveWs Pattern Mapping" ] ] [ fhir:identity [ fhir:v "rim" ] ; fhir:uri [ fhir:v "http://hl7.org/v3" ] ; fhir:name [ fhir:v "RIM Mapping" ] ] ) ; fhir:kind [ fhir:v "resource"] ; fhir:abstract [ fhir:v "false"] ; fhir:type [ fhir:v "PersonalRelationship"] ; fhir:baseDefinition [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource"] ; fhir:derivation [ fhir:v "specialization"] ; fhir:snapshot [ fhir:element ( [ fhir:id [ fhir:v "PersonalRelationship" ] ; fhir:path [ fhir:v "PersonalRelationship" ] ; fhir:short [ fhir:v "A relationship between two indiduals" ] ; fhir:definition [ fhir:v "The details of a direct relationship between two individuals. It does not contain information about the individuals themselves, just the relationship itself." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ; fhir:base [ fhir:path [ fhir:v "PersonalRelationship" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ] ; fhir:constraint ( [ fhir:key [ fhir:v "dom-2" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "If the resource is contained in another resource, it SHALL NOT contain nested Resources" ] ; fhir:expression [ fhir:v "contained.contained.empty()" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ] ] [ fhir:key [ fhir:v "dom-3" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource" ] ; fhir:expression [ fhir:v "contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty()" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ] ] [ fhir:key [ fhir:v "dom-4" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated" ] ; fhir:expression [ fhir:v "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ] ] [ fhir:key [ fhir:v "dom-5" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "If a resource is contained in another resource, it SHALL NOT have a security label" ] ; fhir:expression [ fhir:v "contained.meta.security.empty()" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ] ] [ fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice" ] ; fhir:value [ fhir:v "true" ] ] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation" ] ; fhir:value [ fhir:v "When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time." ] ] ) ; fhir:key [ fhir:v "dom-6" ] ; fhir:severity [ fhir:v "warning" ] ; fhir:human [ fhir:v "A resource should have narrative for robust management" ] ; fhir:expression [ fhir:v "text.`div`.exists()" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/DomainResource" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "false" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "Entity, Role, or Act" ] ] [ fhir:identity [ fhir:v "w5" ] ; fhir:map [ fhir:v "administrative.individual" ] ] ) ] [ fhir:id [ fhir:v "PersonalRelationship.id" ] ; fhir:path [ fhir:v "PersonalRelationship.id" ] ; fhir:short [ fhir:v "Logical id of this artifact" ] ; fhir:definition [ fhir:v "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes." ] ; fhir:comment [ fhir:v "Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "Resource.id" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ] ; fhir:type ( [ fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type" ] ; fhir:value [ fhir:v "id" ] ] ) ; fhir:code [ fhir:v "http://hl7.org/fhirpath/System.String" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ] [ fhir:id [ fhir:v "PersonalRelationship.meta" ] ; fhir:path [ fhir:v "PersonalRelationship.meta" ] ; fhir:short [ fhir:v "Metadata about the resource" ] ; fhir:definition [ fhir:v "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." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "Resource.meta" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ] ; fhir:type ( [ fhir:code [ fhir:v "Meta" ] ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ] [ fhir:id [ fhir:v "PersonalRelationship.implicitRules" ] ; fhir:path [ fhir:v "PersonalRelationship.implicitRules" ] ; fhir:short [ fhir:v "A set of rules under which this content was created" ] ; fhir:definition [ fhir:v "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." ] ; fhir:comment [ fhir:v "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 its narrative along with other profiles, value sets, etc." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "Resource.implicitRules" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ] ; fhir:type ( [ fhir:code [ fhir:v "uri" ] ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "true" ] ; fhir:isModifierReason [ fhir:v "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation" ] ; fhir:isSummary [ fhir:v "true" ] ] [ fhir:id [ fhir:v "PersonalRelationship.language" ] ; fhir:path [ fhir:v "PersonalRelationship.language" ] ; fhir:short [ fhir:v "Language of the resource content" ] ; fhir:definition [ fhir:v "The base language in which the resource is written." ] ; fhir:comment [ fhir:v "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)." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "Resource.language" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ] ; fhir:type ( [ fhir:code [ fhir:v "code" ] ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "false" ] ; fhir:binding [ fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ; fhir:value [ fhir:v "Language" ] ] [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-isCommonBinding" ] ; fhir:value [ fhir:v "true" ] ] ) ; fhir:strength [ fhir:v "required" ] ; fhir:description [ fhir:v "IETF language tag for a human language" ] ; fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2" ] ; fhir:additional ( [ fhir:purpose [ fhir:v "starter" ] ; fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/languages" ] ] ) ] ] [ fhir:id [ fhir:v "PersonalRelationship.text" ] ; fhir:path [ fhir:v "PersonalRelationship.text" ] ; fhir:short [ fhir:v "Text summary of the resource, for human interpretation" ] ; fhir:definition [ fhir:v "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." ] ; fhir:comment [ fhir:v "Contained resources do not have a 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." ] ; fhir:alias ( [ fhir:v "narrative" ] [ fhir:v "html" ] [ fhir:v "xhtml" ] [ fhir:v "display" ] ) ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "DomainResource.text" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ] ; fhir:type ( [ fhir:code [ fhir:v "Narrative" ] ] ) ; fhir:condition ( [ fhir:v "dom-6" ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "false" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "Act.text?" ] ] ) ] [ fhir:id [ fhir:v "PersonalRelationship.contained" ] ; fhir:path [ fhir:v "PersonalRelationship.contained" ] ; fhir:short [ fhir:v "Contained, inline Resources" ] ; fhir:definition [ fhir:v "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning." ] ; fhir:comment [ fhir:v "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." ] ; fhir:alias ( [ fhir:v "inline resources" ] [ fhir:v "anonymous resources" ] [ fhir:v "contained resources" ] ) ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ; fhir:base [ fhir:path [ fhir:v "DomainResource.contained" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ] ; fhir:type ( [ fhir:code [ fhir:v "Resource" ] ] ) ; fhir:condition ( [ fhir:v "dom-2" ] [ fhir:v "dom-4" ] [ fhir:v "dom-3" ] [ fhir:v "dom-5" ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "false" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "N/A" ] ] ) ] [ fhir:id [ fhir:v "PersonalRelationship.extension" ] ; fhir:path [ fhir:v "PersonalRelationship.extension" ] ; fhir:short [ fhir:v "Additional content defined by implementations" ] ; fhir:definition [ fhir:v "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 managable, 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." ] ; fhir:comment [ fhir:v "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." ] ; fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] ) ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ; fhir:base [ fhir:path [ fhir:v "DomainResource.extension" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ] ; fhir:type ( [ fhir:code [ fhir:v "Extension" ] ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "false" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "N/A" ] ] ) ] [ fhir:id [ fhir:v "PersonalRelationship.modifierExtension" ] ; fhir:path [ fhir:v "PersonalRelationship.modifierExtension" ] ; fhir:short [ fhir:v "Extensions that cannot be ignored" ] ; fhir:definition [ fhir:v "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 managable, 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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself)." ] ; fhir:comment [ fhir:v "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." ] ; fhir:requirements [ fhir:v "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](extensibility.html#modifierExtension)." ] ; fhir:alias ( [ fhir:v "extensions" ] [ fhir:v "user content" ] ) ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ; fhir:base [ fhir:path [ fhir:v "DomainResource.modifierExtension" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ] ; fhir:type ( [ fhir:code [ fhir:v "Extension" ] ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "true" ] ; fhir:isModifierReason [ fhir:v "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them" ] ; fhir:isSummary [ fhir:v "true" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "rim" ] ; fhir:map [ fhir:v "N/A" ] ] ) ] [ fhir:id [ fhir:v "PersonalRelationship.source" ] ; fhir:path [ fhir:v "PersonalRelationship.source" ] ; fhir:short [ fhir:v "The individual that is the the source of the relationship" ] ; fhir:definition [ fhir:v "The source is the individual that is described by the relationshipType. In human language, you would say that `source` is the `relationship` of `target`." ] ; fhir:comment [ fhir:v "For example, if the relationship is `daughter`, then the individual that is the `.source` is the `daughter` of the `.target`." ] ; fhir:min [ fhir:v "1" ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "PersonalRelationship.source" ] ; fhir:min [ fhir:v "1" ] ; fhir:max [ fhir:v "1" ] ] ; fhir:type ( [ fhir:code [ fhir:v "Reference" ] ; fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Patient" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Person" ] ) ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ] [ fhir:id [ fhir:v "PersonalRelationship.relationshipType" ] ; fhir:path [ fhir:v "PersonalRelationship.relationshipType" ] ; fhir:short [ fhir:v "The relationship between the source and the target individuals" ] ; fhir:definition [ fhir:v "The relationship the source has with the target." ] ; fhir:comment [ fhir:v "For example, if the relationship is `daughter`, then the individual that is the **.source** is the daughter of the **.target**.\rThe terminology is a heirarchy so can use `:is-a` and other terminology style relationships in search. (i.e. a son is a form of a child)" ] ; fhir:min [ fhir:v "1" ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "PersonalRelationship.relationshipType" ] ; fhir:min [ fhir:v "1" ] ; fhir:max [ fhir:v "1" ] ] ; fhir:type ( [ fhir:code [ fhir:v "CodeableConcept" ] ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ; fhir:binding [ fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ; fhir:value [ fhir:v "PersonalRelationshipType" ] ] ) ; fhir:strength [ fhir:v "preferred" ] ; fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/PersonalRelationship-relationshiptype" ] ] ] [ fhir:id [ fhir:v "PersonalRelationship.target" ] ; fhir:path [ fhir:v "PersonalRelationship.target" ] ; fhir:short [ fhir:v "The individual that is the the target of the relationship" ] ; fhir:definition [ fhir:v "The `target` is the individual to which the `source` is related. In human language, you would say that **source** is the **relationshipType** of **target**." ] ; fhir:comment [ fhir:v "For example, if the relationship is `daughter`, then the individual that is the `.source` is the daughter of the `.target`. " ] ; fhir:min [ fhir:v "1" ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "PersonalRelationship.target" ] ; fhir:min [ fhir:v "1" ] ; fhir:max [ fhir:v "1" ] ] ; fhir:type ( [ fhir:code [ fhir:v "Reference" ] ; fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Patient" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Person" ] ) ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ] [ fhir:id [ fhir:v "PersonalRelationship.period" ] ; fhir:path [ fhir:v "PersonalRelationship.period" ] ; fhir:short [ fhir:v "The period of time during which the relationship is active" ] ; fhir:definition [ fhir:v "The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown." ] ; fhir:comment [ fhir:v "If an individual has a relationship with a patient over multiple, non-adjacent periods, there should be a distinct PersonalRelationship instance for each period. For example, if a person is a roommate for a period of time, moves out, and is later a roommate with the same person again, you would have two PersonalRelationship instances.\r\rMost social relationships are dynamic. For example, an on-again/off-again relationship could be represented as a single PersonalRelationship with multiple periods describing the \"on-again\" periods.\rSome relationships, such as biological relationships, may often be considered permanent (ignoring situations where paternity may be disputed). In cases where the relationships is considered permanent, the .period should be omitted." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ; fhir:base [ fhir:path [ fhir:v "PersonalRelationship.period" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ] ; fhir:type ( [ fhir:code [ fhir:v "Period" ] ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "false" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "w5" ] ; fhir:map [ fhir:v "FiveWs.done[x]" ] ] ) ] [ fhir:id [ fhir:v "PersonalRelationship.confidence" ] ; fhir:path [ fhir:v "PersonalRelationship.confidence" ] ; fhir:short [ fhir:v "The confidence level of this relationship" ] ; fhir:definition [ fhir:v "A coded representation of the confidence in the validity of the relationship." ] ; fhir:requirements [ fhir:v "Sometimes relationship data is externally observed/reported and might not be of high quality. The confidence provides the level of certainty that the `asserter` had of the relationship." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "PersonalRelationship.confidence" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ] ; fhir:type ( [ fhir:code [ fhir:v "CodeableConcept" ] ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ; fhir:binding [ fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ; fhir:value [ fhir:v "Confidence" ] ] ) ; fhir:strength [ fhir:v "example" ] ; fhir:description [ fhir:v "Value to be provided" ] ] ] [ fhir:id [ fhir:v "PersonalRelationship.asserter" ] ; fhir:path [ fhir:v "PersonalRelationship.asserter" ] ; fhir:short [ fhir:v "Who has asserted the details of the relationship" ] ; fhir:definition [ fhir:v "The asserter of the relationship. Typically is the source of the relationship information. (The relationship was reported by ...)." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ; fhir:base [ fhir:path [ fhir:v "PersonalRelationship.asserter" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ] ; fhir:type ( [ fhir:code [ fhir:v "Reference" ] ; fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Patient" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Practitioner" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Organization" ] ) ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "false" ] ] [ fhir:id [ fhir:v "PersonalRelationship.group" ] ; fhir:path [ fhir:v "PersonalRelationship.group" ] ; fhir:short [ fhir:v "This relationship is applicable to the referenced group(s)" ] ; fhir:definition [ fhir:v "Some relationships are applicable within the context of a specific group. Such as a caregiver within a specific household." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ; fhir:base [ fhir:path [ fhir:v "PersonalRelationship.group" ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ] ; fhir:type ( [ fhir:code [ fhir:v "Reference" ] ; fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Group" ] ) ] ) ; fhir:constraint ( [ fhir:key [ fhir:v "ele-1" ] ; fhir:severity [ fhir:v "error" ] ; fhir:human [ fhir:v "All FHIR elements must have a @value or children" ] ; fhir:expression [ fhir:v "hasValue() or (children().count() > id.count())" ] ; fhir:source [ fhir:v "http://hl7.org/fhir/StructureDefinition/Element" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ] ) ] ; fhir:differential [ fhir:element ( [ fhir:id [ fhir:v "PersonalRelationship" ] ; fhir:path [ fhir:v "PersonalRelationship" ] ; fhir:short [ fhir:v "A relationship between two indiduals" ] ; fhir:definition [ fhir:v "The details of a direct relationship between two individuals. It does not contain information about the individuals themselves, just the relationship itself." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "w5" ] ; fhir:map [ fhir:v "administrative.individual" ] ] ) ] [ fhir:id [ fhir:v "PersonalRelationship.source" ] ; fhir:path [ fhir:v "PersonalRelationship.source" ] ; fhir:short [ fhir:v "The individual that is the the source of the relationship" ] ; fhir:definition [ fhir:v "The source is the individual that is described by the relationshipType. In human language, you would say that `source` is the `relationship` of `target`." ] ; fhir:comment [ fhir:v "For example, if the relationship is `daughter`, then the individual that is the `.source` is the `daughter` of the `.target`." ] ; fhir:min [ fhir:v "1" ] ; fhir:max [ fhir:v "1" ] ; fhir:type ( [ fhir:code [ fhir:v "Reference" ] ; fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Patient" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Person" ] ) ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ] [ fhir:id [ fhir:v "PersonalRelationship.relationshipType" ] ; fhir:path [ fhir:v "PersonalRelationship.relationshipType" ] ; fhir:short [ fhir:v "The relationship between the source and the target individuals" ] ; fhir:definition [ fhir:v "The relationship the source has with the target." ] ; fhir:comment [ fhir:v "For example, if the relationship is `daughter`, then the individual that is the **.source** is the daughter of the **.target**.\rThe terminology is a heirarchy so can use `:is-a` and other terminology style relationships in search. (i.e. a son is a form of a child)" ] ; fhir:min [ fhir:v "1" ] ; fhir:max [ fhir:v "1" ] ; fhir:type ( [ fhir:code [ fhir:v "CodeableConcept" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ; fhir:binding [ fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ; fhir:value [ fhir:v "PersonalRelationshipType" ] ] ) ; fhir:strength [ fhir:v "preferred" ] ; fhir:valueSet [ fhir:v "http://hl7.org/fhir/ValueSet/PersonalRelationship-relationshiptype" ] ] ] [ fhir:id [ fhir:v "PersonalRelationship.target" ] ; fhir:path [ fhir:v "PersonalRelationship.target" ] ; fhir:short [ fhir:v "The individual that is the the target of the relationship" ] ; fhir:definition [ fhir:v "The `target` is the individual to which the `source` is related. In human language, you would say that **source** is the **relationshipType** of **target**." ] ; fhir:comment [ fhir:v "For example, if the relationship is `daughter`, then the individual that is the `.source` is the daughter of the `.target`. " ] ; fhir:min [ fhir:v "1" ] ; fhir:max [ fhir:v "1" ] ; fhir:type ( [ fhir:code [ fhir:v "Reference" ] ; fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Patient" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Person" ] ) ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ] [ fhir:id [ fhir:v "PersonalRelationship.period" ] ; fhir:path [ fhir:v "PersonalRelationship.period" ] ; fhir:short [ fhir:v "The period of time during which the relationship is active" ] ; fhir:definition [ fhir:v "The period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown." ] ; fhir:comment [ fhir:v "If an individual has a relationship with a patient over multiple, non-adjacent periods, there should be a distinct PersonalRelationship instance for each period. For example, if a person is a roommate for a period of time, moves out, and is later a roommate with the same person again, you would have two PersonalRelationship instances.\r\rMost social relationships are dynamic. For example, an on-again/off-again relationship could be represented as a single PersonalRelationship with multiple periods describing the \"on-again\" periods.\rSome relationships, such as biological relationships, may often be considered permanent (ignoring situations where paternity may be disputed). In cases where the relationships is considered permanent, the .period should be omitted." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ; fhir:type ( [ fhir:code [ fhir:v "Period" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "false" ] ; fhir:mapping ( [ fhir:identity [ fhir:v "w5" ] ; fhir:map [ fhir:v "FiveWs.done[x]" ] ] ) ] [ fhir:id [ fhir:v "PersonalRelationship.confidence" ] ; fhir:path [ fhir:v "PersonalRelationship.confidence" ] ; fhir:short [ fhir:v "The confidence level of this relationship" ] ; fhir:definition [ fhir:v "A coded representation of the confidence in the validity of the relationship." ] ; fhir:requirements [ fhir:v "Sometimes relationship data is externally observed/reported and might not be of high quality. The confidence provides the level of certainty that the `asserter` had of the relationship." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ; fhir:type ( [ fhir:code [ fhir:v "CodeableConcept" ] ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ; fhir:binding [ fhir:extension ( [ fhir:url [ fhir:v "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName" ] ; fhir:value [ fhir:v "Confidence" ] ] ) ; fhir:strength [ fhir:v "example" ] ; fhir:description [ fhir:v "Value to be provided" ] ] ] [ fhir:id [ fhir:v "PersonalRelationship.asserter" ] ; fhir:path [ fhir:v "PersonalRelationship.asserter" ] ; fhir:short [ fhir:v "Who has asserted the details of the relationship" ] ; fhir:definition [ fhir:v "The asserter of the relationship. Typically is the source of the relationship information. (The relationship was reported by ...)." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "1" ] ; fhir:type ( [ fhir:code [ fhir:v "Reference" ] ; fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Patient" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/RelatedPerson" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Practitioner" ] [ fhir:v "http://hl7.org/fhir/StructureDefinition/Organization" ] ) ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "false" ] ] [ fhir:id [ fhir:v "PersonalRelationship.group" ] ; fhir:path [ fhir:v "PersonalRelationship.group" ] ; fhir:short [ fhir:v "This relationship is applicable to the referenced group(s)" ] ; fhir:definition [ fhir:v "Some relationships are applicable within the context of a specific group. Such as a caregiver within a specific household." ] ; fhir:min [ fhir:v "0" ] ; fhir:max [ fhir:v "*" ] ; fhir:type ( [ fhir:code [ fhir:v "Reference" ] ; fhir:targetProfile ( [ fhir:v "http://hl7.org/fhir/StructureDefinition/Group" ] ) ] ) ; fhir:mustSupport [ fhir:v "false" ] ; fhir:isModifier [ fhir:v "false" ] ; fhir:isSummary [ fhir:v "true" ] ] ) ] . # -------------------------------------------------------------------------------------
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
FHIR ®© HL7.org 2011+. FHIR R6 hl7.fhir.core#6.0.0-ballot2 generated on Mon, Nov 11, 2024 07:30+0000.
Links: Search |
Version History |
Contents |
Glossary |
QA |
Compare to R5 |
|
Propose a change