Page Status: updated 2024-08-28

NLLAccessConsent (Consent)

Page index

Introduction

The Consent resource, shown in the profile NLLAccessConsent (sv: registrerat åtkomstsamtycke) represents a consent for a health care professional to access a patient's medication list.

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
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedS Σ0..1instant
sourceΣ0..1uri
profileΣ0..*canonical(StructureDefinition)
id0..1string
extensionI0..*Extension
systemS Σ0..1uri
versionS Σ0..1string
codeS Σ0..1code
displayΣ0..1string
userSelectedΣ0..1boolean
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
id0..1string
extensionI0..*Extension
url1..1uriFixed Value
id0..1string
extensionI0..*Extension
startS Σ I1..1dateTime
endS Σ I1..1dateTime
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
statusS Σ ?!1..1codeBinding
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionS Σ0..1string
codeS Σ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionS Σ0..1string
codeS Σ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
dateTimeΣ0..1dateTime
performerΣ I0..*Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)
organizationΣ I0..*Reference(Organization)
sourceAttachmentAttachment
sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
authorityI0..1uri
uriS I0..1uriFixed Value
policyRuleΣ I0..1CodeableConceptBinding
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
verifiedΣ1..1boolean
verifiedWithI0..1Reference(Patient | RelatedPerson)
verificationDate0..1dateTime
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
typeΣ0..1codeBinding
id0..1string
extensionI0..*Extension
startS Σ I1..1dateTime
endS Σ I1..1dateTime
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionS Σ0..1string
codeS Σ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
textΣ0..1string
id0..1string
extensionI0..*Extension
referenceS Σ I0..1string
typeS Σ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
actionΣ0..*CodeableConcept
id0..1string
extensionI0..*Extension
systemS Σ0..1uriFixed Value
versionS Σ0..1string
codeS Σ0..1codeFixed Value
displayΣ0..1string
userSelectedΣ0..1boolean
purposeΣ0..*CodingBinding
classΣ0..*CodingBinding
codeΣ0..*CodeableConcept
dataPeriodΣ I0..1Period
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
meaningΣ1..1codeBinding
referenceΣ I1..1Reference(Resource)
provision0..*see (provision)

Details

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

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

Statuses

Status Description
proposed The consent is requested by a health care professional
active The consent is accepted by the patient or created directly by the patient
inactive The consent is canceled by the patient or automatically discontinued

Inactive consents are usually not visible.

Category

Status Description
consent-dose-disp The consent is a multi dose dispense consent, i.e. based on NLLMultiDoseDispConsent
INFA The consent is an access consent, i.e. based on NLLAccessConsent

Supported operations

HTTP methods

Operation Supported Comment
Search (GET, POST) yes See below for supported search options.
Insert (POST) yes Create a new access consent. Currently only as a request by a health care professional.
Update (PUT) yes Accept (patient) or terminate (patient, practitioner) a request.
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. ../Consent/[id]
  2. ../Consent/[id]/_history{/[vid]}
  3. ../Consent?[parameters]
    Parameter chain:
    patient._id=[id]
    &category=INFA
    {&actor.type=[string]}
    {&practitioner.qualification.identifier=[string]}
    {&practitioner.identifier=[string]} (NB! Deprecated. Use practitioner.qualification.identifier )
    {&status=[string]}

Compartment searches

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

  1. ../Consent/[id]/Provenances returns all Provenances related to a specific Consent.

NB! ../Patient/[id]/Consent returns only multi dose dispense Consents.

Include & reverse includes

Supported usage of include and revinclude. This kind of search returns a bundle of both the base resource and the related resources specified in the parameter.

  1. ../Consent?[parameters]&_revinclude=Provenance:target:Consent returns one or more Consents together with their Provenances. The Provenance returned is the one pointing at the returned version of the Consent. See above for a list of valid parameters.

Example: ../Consent?patient._id=<uuid>&category=INFA&_revinclude=Provenance:target:Consent returns all the patient's access consents including one provenance per consent.

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

Search parameters

The table below shows all supported search parameters.

Parameter Description Comment
Consent/[id] A read based on the logical ID (UUID) of a consent
../Consent/<uuid>
_history A vread to get all versions of a consent
../Consent/<uuid>/_history
_history/[vid] A vread to get a specific version of a consent
../Consent/<uuid>/_history/3
patient._id ..&patient._id=<uuid>
category ..&category=INFA Access consent is INFA
Multi dose disp consent is consent-dose-disp
actor.type ..&actor.type=Practitioner Currently only Practitioner is available as a type
practitioner.identifier ..&practitioner.identifier=urn:oid:1.2.752.116.3.1.2|9000027 A practitioner can be identified by a "förskrivarkod" or by "legitimationskod"
Förskrivarkod is identified by urn:oid:1.2.752.116.3.1.2
Legitimationskod is identified by urn:oid:1.2.752.116.3.1.1
If neither of these are provided, the information in the security ticket is used instead. See rule R005 in TA 54 in "Handbok".
status ..&status=Active Active or Proposed