Page Status: updated 2022-03-18

Patient

Page index

Introduction

The Patient resource, shown in the profile NLLPatient, represents a person who has one or more prescriptions (MedicationRequest) or in some cases only dispenses (MedicationDispenses), either active or in-active (within the legitimate timeframe) in the National Medication List.

A patient is normally fetched from NLL to get the logical identifier, which is used in subsequent interactions. For cases where the patient doesn't have a personal identifier, it is instead created as part of the MedicationRequest, i.e. the information about the person is contained within the medication request.

Overview

idS Σ0..1System.String
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileΣ0..*canonical(StructureDefinition)
systemS Σ0..1uri
versionS Σ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
tagΣ0..*Coding
url1..1System.StringFixed Value
systemS Σ0..1uri
versionS Σ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
useΣ ?!0..1codeBinding
typeΣ0..1CodeableConceptBinding
systemS Σ1..1uriFixed Value
valueS Σ I1..1string
periodΣ I0..1Period
assignerΣ I0..1Reference(Organization)
activeS Σ ?!0..1boolean
useΣ ?!0..1codeBinding
textS Σ0..1string
familyS Σ0..1string
nllNameQualifierS I0..*Extension(code)Binding
prefixΣ0..*string
suffixΣ0..*string
periodΣ I0..1Period
telecomΣ I0..*ContactPoint
genderS Σ0..1codeBinding
birthDateS Σ0..1date
deceasedBooleanboolean
nllMunicipalityCodeS I0..1Extension(code)Binding
nllRegionCodeS I0..1Extension(code)Binding
useΣ ?!0..1codeBinding
typeΣ0..1codeBinding
textΣ0..1string
lineΣ0..*string
cityΣ0..1string
districtΣ0..1string
stateΣ0..1string
postalCodeΣ0..1string
countryΣ0..1string
periodΣ I0..1Period
maritalStatus0..1CodeableConceptBinding
multipleBirthBooleanboolean
multipleBirthIntegerinteger
photoI0..*Attachment
relationship0..*CodeableConceptBinding
name0..1HumanName
telecomI0..*ContactPoint
address0..1Address
gender0..1codeBinding
organizationI0..1Reference(Organization)
periodI0..1Period
language1..1CodeableConceptBinding
preferred0..1boolean
generalPractitionerI0..*Reference(Organization | Practitioner | PractitionerRole)
managingOrganizationΣ I0..1Reference(Organization)
otherΣ I1..1Reference(Patient | RelatedPerson)
typeΣ1..1codeBinding

Contained resources

The patient resource will be a contained resource when an explicit business identifier (personal identity number, sv. personnummer) is missing. In that case the patient is identified by name and birthdate.

Cases when patient is a contained resource Resources using patient
No business identifier, ie no personal identity number MedicationRequest,
MedicationDispense

For more information about references and contained resources see Resources - References.

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) yes See below for supported extended operations.

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

  1. ../Patient/[id]
  2. ../Patient?identifier=[value]

Compartment searches

Supported searches on a compartment. This kind of search returns a bundle with the related resources.

  1. ../Patient/[id]/MedicationRequest{?[parameters]} returns all related MedicationRequests for the specified patient matching the optional parameters.

  2. ../Patient/[id]/Consent returns all related Consents for the specified patient.

  3. ../Patient/[id]/MedicationListInfo returns all related MedicationListInfo's for the specified patient.

Search parameters

Parameter Description Comment
Patient/[id] A read based on the logical ID (UUID) of a patient request
../Patient/<uuid>
identifier Business identifier of a patient including the naming system
..?identifier=http://electronichealth.se/identifier/personnummer%7C196411193086
An identifier is a combination of a type and a value seperated by a | (%7C)

Other operations

Operation name HTTP verbs Comment
$print-prescriptions GET, POST

The resource cannot be rendered.

$print-dispenses GET, POST

Invocations

URL: [base]/Patient/[id]/$print-dispenses

This operation does NOT change content

Return Values (Out)

NameCardinalityTypeDocumentation
return1..1Binary

The Binary resource containes a Base64 encoded PDF file which includes a patient's dispensed medications.

Can be invoked with a HTTP POST or GET. This operation is invoked on a Patient resource to initiate the creation of a PDF report including the patient's dispensed medications. Dispenses of other types of products are not included. NB! The response containes a Binary resource without the parameter format.

$print-dose-prescriptions GET, POST

Invocations

URL: [base]/Patient/[id]/$print-dose-prescriptions

This operation does NOT change content

Parameters (In)

NameCardinalityTypeDocumentation
pharmacyGLN0..1string

If this operation is invoced by a pharmacy, the pharmacy GLN must be provided. Otherwise no GLN should be provided.

Return Values (Out)

NameCardinalityTypeDocumentation
return1..1Binary

The Binary resource containes a Base64 encoded PDF file which includes a list of all prescriptions with status "active" if the patient has a dose dispesing consent.

Can be invoked with an HTTP POST or GET. This operation can only be invoked on a patient with a dose dispensing consent. The operation is invoked on a Patient resource and initiates the creation of a pdf report which includes the selected patient's all prescriptions, both dose dispensed and ordinary packaged prescriptions. NB! The response containes a Binary resource without the parameter format

Example POST [base]/Patient/[id]/$print-prescriptions