Page Status: updated 2022-03-22

RelatedPerson

Page index

Introduction

The RelatedPerson resource, shown in the profile NLLRelatedPerson, represents a person who is related to a patient. In the Swedish National Medication List, this resource is used to represent a guardian and the relationship to a child (the patient). The relation is always one guardian to one patient.

A search is performed by the guardian id and patient id as query parameters, and the resource is only returned if both persons exists and they have a relationship.

Regarding information about how the "must support"-property is used in the Swedish National MedicationList, please refer to the page Resources

Overview

idS Σ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
id0..1string
extensionI0..*Extension
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ I1..1string
periodΣ0..1Period
assignerΣ0..1Reference(Organization)
activeΣ ?!0..1boolean
patientS Σ1..1Reference(NLLPatient)
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
nameΣ0..*HumanName
telecomΣ0..*ContactPoint
genderΣ0..1codeBinding
birthDateΣ0..1date
addressΣ0..*Address
photo0..*Attachment
period0..1Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
language1..1CodeableConceptBinding
preferred0..1boolean
RelatedPerson
DefinitionRepresents the relation between a person acting as a guardian (sv: vårdnadshavare) and a patient (child). Only represents a one to one mapping - meaning one care taker and one child.
Cardinality0...*
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-3: 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
    contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
  • dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
    contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • dom-6: A resource should have narrative for robust management
    text.`div`.exists()
Mappings
  • rim: Entity. Role, or Act
  • rim: role
  • EHM: Vårdnadshavare
RelatedPerson.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
Must SupportTrue
SummaryTrue
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.

Mappings
  • EHM: Vårdnadshavarrelations-id
RelatedPerson.meta
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.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
RelatedPerson.implicitRules
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.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
RelatedPerson.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
RelatedPerson.text
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.
Cardinality0...1
TypeNarrative
Aliasnarrative, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: Act.text?
RelatedPerson.contained
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.
Cardinality0...*
TypeResource
Aliasinline 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
  • rim: N/A
RelatedPerson.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
RelatedPerson.modifierExtension
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).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
RelatedPerson.identifier
DefinitionIdentifier for a person within a particular scope.
Cardinality0...*
TypeIdentifier
Must SupportTrue
SummaryTrue
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.

SlicingUnordered, Open, by system(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: NK1-33
  • rim: .id
RelatedPerson.identifier:pnr
DefinitionIdentifies the related person of the patient, e.g. the guardian.
Cardinality0...*
TypeIdentifier
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.identifier
  • v2: NK1-33
  • rim: .id
  • EHM: Personnummer
RelatedPerson.identifier:pnr.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
RelatedPerson.identifier:pnr.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
RelatedPerson.identifier:pnr.use
DefinitionThe purpose of this identifier.
Cardinality0...1
Typecode
Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)
ModifierTrue
SummaryTrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: N/A
  • rim: Role.code or implied by context
RelatedPerson.identifier:pnr.type
DefinitionA coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
Cardinality0...1
TypeCodeableConcept
Binding

A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

Identifier Type Codes (extensible)
SummaryTrue
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.5
  • rim: Role.code or implied by context
RelatedPerson.identifier:pnr.system
DefinitionEstablishes the namespace for the value - that is, a URL that describes a set values that are unique.
Cardinality1...1
Typeuri
Must SupportTrue
SummaryTrue
Requirements

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.

Comments

Identifier.system is always case sensitive.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://electronichealth.se/identifier/personnummer

Mappings
  • v2: CX.4 / EI-2-4
  • rim: II.root or Role.id.root
  • servd: ./IdentifierType
RelatedPerson.identifier:pnr.value
DefinitionValue of the identifier, a swedish national identification number which must be a 12 digit numeric value.
Cardinality1...1
Typestring
Must SupportTrue
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • swe-id-rule: Personal id must have 12 digits
    $this.matches('^\\d{12}$')
Examples
General

123456


Mappings
  • v2: CX.1 / EI.1
  • rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
  • servd: ./Value
RelatedPerson.identifier:pnr.period
DefinitionTime period during which identifier is/was valid for use.
Cardinality0...1
TypePeriod
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.7 + CX.8
  • rim: Role.effectiveTime or implied by context
  • servd: ./StartDate and ./EndDate
RelatedPerson.identifier:pnr.assigner
DefinitionOrganization that issued/manages the identifier.
Cardinality0...1
TypeReference(Organization)
SummaryTrue
Comments

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.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: CX.4 / (CX.4,CX.9,CX.10)
  • rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
  • servd: ./IdentifierIssuingAuthority
RelatedPerson.active
DefinitionWhether this related person record is in active use.
Cardinality0...1
Typeboolean
ModifierTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.status
  • rim: .statusCode
RelatedPerson.patient
DefinitionThe patient (a child) this person (the guardian) is related to.
Cardinality1...1
TypeReference(NLLPatient)
Must SupportTrue
SummaryTrue
Requirements

We need to know which patient this RelatedPerson is related to.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: PID-3
  • rim: scoper[classCode=PSN|ANM and determinerCode='INSTANCE']/playedRole[classCode='PAT']/id
  • EHM: Patientreferens
RelatedPerson.relationship
DefinitionThe nature of the relationship, fixed to GUARD (guardian) sv: vårdnadshavare since NLL currently only supports related person of this type.
Cardinality1...1
TypeCodeableConcept
Binding

The nature of the relationship between a patient and the related person.

Typ av relation (relationship-types) (required)
Must SupportTrue
SummaryTrue
Requirements

We need to know the relationship with the patient since it influences the interpretation of the information attributed to this person.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

{
  "coding": [
    {
      "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code": "GUARD"
    }
  ]
}

Mappings
  • w5: FiveWs.class
  • v2: NK1-3
  • rim: code
RelatedPerson.relationship.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
RelatedPerson.relationship.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
RelatedPerson.relationship.coding
DefinitionA reference to a code defined by a terminology system.
Cardinality1...1
TypeCoding
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

{
  "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
  "code": "GUARD"
}

Mappings
  • v2: C*E.1-8, C*E.10-22
  • rim: union(., ./translation)
  • orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
RelatedPerson.relationship.coding.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
RelatedPerson.relationship.coding.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, 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.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
RelatedPerson.relationship.coding.system
DefinitionThe identification of the code system that defines the meaning of the symbol in the code.
Cardinality1...1
Typeuri
Must SupportTrue
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

http://terminology.hl7.org/CodeSystem/v3-RoleCode

Mappings
  • v2: C*E.3
  • rim: ./codeSystem
  • orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem
RelatedPerson.relationship.coding.version
DefinitionThe version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.7
  • rim: ./codeSystemVersion
  • orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion
RelatedPerson.relationship.coding.code
DefinitionA symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
Cardinality1...1
Typecode
Must SupportTrue
SummaryTrue
Requirements

Need to refer to a particular code in the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Fixed Value

GUARD

Mappings
  • v2: C*E.1
  • rim: ./code
  • orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code
  • EHM: Relation
RelatedPerson.relationship.coding.display
DefinitionA representation of the meaning of the code in the system, following the rules of the system.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.2 - but note this is not well followed
  • rim: CV.displayName
  • orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName
RelatedPerson.relationship.coding.userSelected
DefinitionIndicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).
Cardinality0...1
Typeboolean
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: Sometimes implied by being first
  • rim: CD.codingRationale
  • orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]
RelatedPerson.relationship.text
DefinitionA human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Cardinality0...1
Typestring
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: C*E.9. But note many systems use C*E.2 for this
  • rim: ./originalText[mediaType/code="text/plain"]/data
  • orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
RelatedPerson.name
DefinitionA name associated with the person.
Cardinality0...*
TypeHumanName
SummaryTrue
Requirements

Related persons need to be identified by name, but it is uncommon to need details about multiple other names for that person.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NK1-2
  • rim: name
RelatedPerson.telecom
DefinitionA contact detail for the person, e.g. a telephone number or an email address.
Cardinality0...*
TypeContactPoint
SummaryTrue
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NK1-5 / NK1-6 / NK1-40
  • rim: telecom
RelatedPerson.gender
DefinitionAdministrative Gender - the gender that the person is considered to have for administration and record keeping purposes.
Cardinality0...1
Typecode
Binding

The gender of a person used for administrative purposes.

AdministrativeGender (required)
SummaryTrue
Requirements

Needed for identification of the person, in combination with (at least) name and birth date.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NK1-15
  • rim: administrativeGender
RelatedPerson.birthDate
DefinitionThe date on which the related person was born.
Cardinality0...1
Typedate
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: player.birthTime
RelatedPerson.address
DefinitionAddress where the related person can be contacted or visited.
Cardinality0...*
TypeAddress
SummaryTrue
Requirements

Need to keep track where the related person can be contacted per postal mail or visited.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: NK1-4
  • rim: addr
RelatedPerson.photo
DefinitionImage of the person.
Cardinality0...*
TypeAttachment
Requirements

Many EHR systems have the capability to capture an image of persons. Fits with newer social media usage too.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • v2: OBX-5 - needs a profile
  • rim: player[classCode='PSN' and determinerCode='INSTANCE']/desc
RelatedPerson.period
DefinitionThe period of time during which this relationship is or was active. If there are no dates defined, then the interval is unknown.
Cardinality0...1
TypePeriod
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • w5: FiveWs.done[x]
  • rim: .effectiveTime
RelatedPerson.communication
DefinitionA language which may be used to communicate with about the patient's health.
Cardinality0...*
TypeBackboneElement
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: LanguageCommunication
RelatedPerson.communication.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
RelatedPerson.communication.extension
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.
Cardinality0...*
TypeExtension
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
RelatedPerson.communication.modifierExtension
DefinitionMay 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).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, 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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: N/A
RelatedPerson.communication.language
DefinitionThe 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.
Cardinality1...1
TypeCodeableConcept
Binding

A human language.

CommonLanguages (preferred)
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: player[classCode=PSN|ANM and determinerCode=INSTANCE]/languageCommunication/code
RelatedPerson.communication.preferred
DefinitionIndicates whether or not the patient prefers this language (over other languages he masters up a certain level).
Cardinality0...1
Typeboolean
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
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: preferenceInd
<StructureDefinition xmlns="http://hl7.org/fhir">
    <url value="http://electronichealth.se/fhir/StructureDefinition/NLLRelatedPerson" />
    <version value="1.0.0" />
    <name value="NLLRelatedPerson" />
    <status value="active" />
    <date value="2022-02-02" />
    <publisher value="Swedish eHealth Agency" />
    <description value="Information about a person that is related to a patient. Used in NLL primarily to represent the guardian of a child." />
    <fhirVersion value="4.0.1" />
    <mapping>
        <identity value="EHM" />
        <name value="E-h&#228;lsomyndigheten concept" />
    </mapping>
    <kind value="resource" />
    <abstract value="false" />
    <type value="RelatedPerson" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" />
    <derivation value="constraint" />
    <differential>
        <element id="RelatedPerson">
            <path value="RelatedPerson" />
            <short value="A person that is related to a patient in the form of guardian (sv: v&#229;rdnadshavare)" />
            <definition value="Represents the relation between a person acting as a guardian (sv: v&#229;rdnadshavare) and a patient (child). Only represents a one to one mapping - meaning one care taker and one child." />
            <mapping>
                <identity value="EHM" />
                <map value="V&#229;rdnadshavare" />
            </mapping>
        </element>
        <element id="RelatedPerson.id">
            <path value="RelatedPerson.id" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="V&#229;rdnadshavarrelations-id" />
            </mapping>
        </element>
        <element id="RelatedPerson.identifier">
            <path value="RelatedPerson.identifier" />
            <slicing>
                <discriminator>
                    <type value="value" />
                    <path value="system" />
                </discriminator>
                <rules value="open" />
            </slicing>
            <mustSupport value="true" />
        </element>
        <element id="RelatedPerson.identifier:pnr">
            <path value="RelatedPerson.identifier" />
            <sliceName value="pnr" />
            <short value="Identifier of related person" />
            <definition value="Identifies the related person of the patient, e.g. the guardian." />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Personnummer" />
            </mapping>
        </element>
        <element id="RelatedPerson.identifier:pnr.system">
            <path value="RelatedPerson.identifier.system" />
            <min value="1" />
            <fixedUri value="http://electronichealth.se/identifier/personnummer" />
            <mustSupport value="true" />
        </element>
        <element id="RelatedPerson.identifier:pnr.value">
            <path value="RelatedPerson.identifier.value" />
            <short value="The value, swedish national identification number" />
            <definition value="Value of the identifier, a swedish national identification number which must be a 12 digit numeric value." />
            <min value="1" />
            <constraint>
                <key value="swe-id-rule" />
                <severity value="error" />
                <human value="Personal id must have 12 digits" />
                <expression value="$this.matches(&#39;^\\d{12}$&#39;)" />
                <source value="RelatedPerson" />
            </constraint>
            <mustSupport value="true" />
        </element>
        <element id="RelatedPerson.patient">
            <path value="RelatedPerson.patient" />
            <definition value="The patient (a child) this person (the guardian) is related to." />
            <type>
                <code value="Reference" />
                <targetProfile value="http://electronichealth.se/fhir/StructureDefinition/NLLPatient" />
                <aggregation value="referenced" />
            </type>
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Patientreferens" />
            </mapping>
        </element>
        <element id="RelatedPerson.relationship">
            <path value="RelatedPerson.relationship" />
            <definition value="The nature of the relationship, fixed to GUARD (guardian) sv: v&#229;rdnadshavare since NLL currently only supports related person of this type." />
            <min value="1" />
            <max value="1" />
            <fixedCodeableConcept>
                <coding>
                    <system value="http://terminology.hl7.org/CodeSystem/v3-RoleCode" />
                    <code value="GUARD" />
                </coding>
            </fixedCodeableConcept>
            <mustSupport value="true" />
            <binding>
                <strength value="required" />
                <valueSet value="http://electronichealth.se/fhir/ValueSet/relationship-types" />
            </binding>
        </element>
        <element id="RelatedPerson.relationship.coding">
            <path value="RelatedPerson.relationship.coding" />
            <min value="1" />
            <max value="1" />
            <mustSupport value="true" />
        </element>
        <element id="RelatedPerson.relationship.coding.system">
            <path value="RelatedPerson.relationship.coding.system" />
            <min value="1" />
            <mustSupport value="true" />
        </element>
        <element id="RelatedPerson.relationship.coding.code">
            <path value="RelatedPerson.relationship.coding.code" />
            <min value="1" />
            <mustSupport value="true" />
            <mapping>
                <identity value="EHM" />
                <map value="Relation" />
            </mapping>
        </element>
    </differential>
</StructureDefinition>
{
    "resourceType": "StructureDefinition",
    "url": "http://electronichealth.se/fhir/StructureDefinition/NLLRelatedPerson",
    "version": "1.0.0",
    "name": "NLLRelatedPerson",
    "status": "active",
    "date": "2022-02-02",
    "publisher": "Swedish eHealth Agency",
    "description": "Information about a person that is related to a patient. Used in NLL primarily to represent the guardian of a child.",
    "fhirVersion": "4.0.1",
    "mapping":  [
        {
            "identity": "EHM",
            "name": "E-hälsomyndigheten concept"
        }
    ],
    "kind": "resource",
    "abstract": false,
    "type": "RelatedPerson",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "RelatedPerson",
                "path": "RelatedPerson",
                "short": "A person that is related to a patient in the form of guardian (sv: vårdnadshavare)",
                "definition": "Represents the relation between a person acting as a guardian (sv: vårdnadshavare) and a patient (child). Only represents a one to one mapping - meaning one care taker and one child.",
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Vårdnadshavare"
                    }
                ]
            },
            {
                "id": "RelatedPerson.id",
                "path": "RelatedPerson.id",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Vårdnadshavarrelations-id"
                    }
                ]
            },
            {
                "id": "RelatedPerson.identifier",
                "path": "RelatedPerson.identifier",
                "slicing": {
                    "discriminator":  [
                        {
                            "type": "value",
                            "path": "system"
                        }
                    ],
                    "rules": "open"
                },
                "mustSupport": true
            },
            {
                "id": "RelatedPerson.identifier:pnr",
                "path": "RelatedPerson.identifier",
                "sliceName": "pnr",
                "short": "Identifier of related person",
                "definition": "Identifies the related person of the patient, e.g. the guardian.",
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Personnummer"
                    }
                ]
            },
            {
                "id": "RelatedPerson.identifier:pnr.system",
                "path": "RelatedPerson.identifier.system",
                "min": 1,
                "fixedUri": "http://electronichealth.se/identifier/personnummer",
                "mustSupport": true
            },
            {
                "id": "RelatedPerson.identifier:pnr.value",
                "path": "RelatedPerson.identifier.value",
                "short": "The value, swedish national identification number",
                "definition": "Value of the identifier, a swedish national identification number which must be a 12 digit numeric value.",
                "min": 1,
                "constraint":  [
                    {
                        "key": "swe-id-rule",
                        "severity": "error",
                        "human": "Personal id must have 12 digits",
                        "expression": "$this.matches('^\\\\d{12}$')",
                        "source": "RelatedPerson"
                    }
                ],
                "mustSupport": true
            },
            {
                "id": "RelatedPerson.patient",
                "path": "RelatedPerson.patient",
                "definition": "The patient (a child) this person (the guardian) is related to.",
                "type":  [
                    {
                        "code": "Reference",
                        "targetProfile":  [
                            "http://electronichealth.se/fhir/StructureDefinition/NLLPatient"
                        ],
                        "aggregation":  [
                            "referenced"
                        ]
                    }
                ],
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Patientreferens"
                    }
                ]
            },
            {
                "id": "RelatedPerson.relationship",
                "path": "RelatedPerson.relationship",
                "definition": "The nature of the relationship, fixed to GUARD (guardian) sv: vårdnadshavare since NLL currently only supports related person of this type.",
                "min": 1,
                "max": "1",
                "fixedCodeableConcept": {
                    "coding":  [
                        {
                            "system": "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
                            "code": "GUARD"
                        }
                    ]
                },
                "mustSupport": true,
                "binding": {
                    "strength": "required",
                    "valueSet": "http://electronichealth.se/fhir/ValueSet/relationship-types"
                }
            },
            {
                "id": "RelatedPerson.relationship.coding",
                "path": "RelatedPerson.relationship.coding",
                "min": 1,
                "max": "1",
                "mustSupport": true
            },
            {
                "id": "RelatedPerson.relationship.coding.system",
                "path": "RelatedPerson.relationship.coding.system",
                "min": 1,
                "mustSupport": true
            },
            {
                "id": "RelatedPerson.relationship.coding.code",
                "path": "RelatedPerson.relationship.coding.code",
                "min": 1,
                "mustSupport": true,
                "mapping":  [
                    {
                        "identity": "EHM",
                        "map": "Relation"
                    }
                ]
            }
        ]
    }
}
RelatedPerson..
RelatedPerson.id..
RelatedPerson.identifier..
RelatedPerson.identifier..
RelatedPerson.identifier.system1..
RelatedPerson.identifier.value1..
RelatedPerson.patientReference(NLLPatient)..
RelatedPerson.relationship1..1
RelatedPerson.relationship.coding1..1
RelatedPerson.relationship.coding.system1..
RelatedPerson.relationship.coding.code1..

Details

Description of all elements can be found here, Element descriptions.

Mapping of FHIR element names to the National Medication List names can be found here, Element language mappings.

Supported operations

HTTP methods

Operation Supported Comment
Search (GET, POST) yes See below for supported search options.
Insert (POST) no
Update (PUT) no
Delete (DEL) no
Operation (GET, POST) no

When interacting with this resource a set of HTTP-headers must be included in the request, see HTTP Header and Authorization.

Query operations

Supported queries

The following query alternatives are available for this resource.

  1. ../RelatedPerson/[id]
  2. ../RelatedPerson?identifier=[value]&patient._id=[id]
  3. ../RelatedPerson?[parameters]
    Parameter chain:
    identifier=[value]
    &patient.identifier=[value]

Compartment searches

This resource is not involved in any searches by a compartment.

Include & reverse includes

Include and revinclude are not supported by this resource.

For generic information about how to search in FHIR look here.

Search parameters

The table below shows all supported search parameters.

Parameter Description Comment
RelatedPerson/[id] A read based on the logical ID of a related person
../RelatedPerson/<uuid>-<uuid>
The id is a combination of a persons' id and the related persons' id
identifier Swedish national identification number of the guardian
..?identifier=http://electronichealth.se/identifier/personnummer%7C201701012393
An identifier is a combination of a type and a value seperated by a | (%7C)
patient._id Logical ID of the patient.
..&patient._id=<uuid>
patient.identifier Swedish national identification number of the patient
..&patient.identifier=http://electronichealth.se/identifier/personnummer%7C201701012393
An identifier is a combination of a type identifier and a value seperated by a | (%7C)

Other operations (extensions)

This resource has no extended operations.