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.

Overview

idS Σ0..1System.String
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ I1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
activeΣ ?!0..1boolean
patientS Σ I1..1Reference(NLLPatient)
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
nameΣ0..*HumanName
telecomΣ I0..*ContactPoint
genderΣ0..1codeBinding
birthDateΣ0..1date
addressΣ0..*Address
photoI0..*Attachment
periodI0..1Period
language1..1CodeableConceptBinding
preferred0..1boolean

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.