Security
and
Privacy
This
page
is
part
of
the
FHIR
Specification
(v4.3.0:
R4B
(v5.0.0-ballot:
R5
Ballot
-
STU
see
ballot
notes
).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
| Community Based Collaborative Care Work Group | Maturity Level : N/A | Standards Status : Informative | Compartments : Patient |
Raw JSON ( canonical form + also see JSON Format Specification )
Example of Patients Know Best Usage
{
"resourceType": "Consent",
"id": "consent-example-pkb",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p>\n This example demonstrates how to encode this screen shot in a consent resource:\n\t\t\t</p>\n\t\t\t<p>\n\t\t\t\t<img src=\"pkb.png\" alt=\"Screenshot from Patient Knows Best\"/>\n\t\t\t</p>\n\t\t\t<p>\n Thanks to <a href=\"https://www.patientsknowbest.com/\">Patients Know Best</a> for contributing this example\n\t\t\t</p>\n\t\t</div>"
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>This example demonstrates how to encode this screen shot in a consent resource:</p>\n <p>\n <img src=\"pkb.png\" alt=\"Screenshot from Patient Knows Best\"/>\n </p>\n <p>Thanks to <a href=\"https://www.patientsknowbest.com/\">Patients Know Best</a> for contributing this example</p>\n <p>Example uses SecurityLabels to define data types</p>\n </div>"
},
"status": "active",
"scope": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentscope",
"code": "patient-privacy"
}
]
},
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "59284-0"
}
]
}
],
"patient": {
"subject": {
"reference": "Patient/example",
"display": "...example patient..."
"display": "Peter James Chalmers"
},
"dateTime": "2016-06-16",
"organization": [
"dateTime": "2018-12-28",
"controller": [
{
"reference": "Organization/f001"
}
],
"policyRule": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "OPTOUT"
}
]
},
"provision": {
"actor": [
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
}
]
},
"reference": {
"reference": "Organization/f001"
"regulatoryBasis": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "INFA"
}
}
],
"action": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
"code": "N"
}
],
]
}
],
"provision": {
"type": "deny",
"provision": [
{
"type": "permit",
"actor": [
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
}
]
},
"reference": {
"reference": "Organization/f001"
}
}
],
"action": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "PSY"
}
]
},
{
"actor": [
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
}
]
},
"reference": {
"reference": "Organization/f001"
}
"system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
"code": "N"
}
],
"action": [
"provision": [
{
"coding": [
"type": "permit",
"actor": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
}
]
},
"reference": {
"reference": "Organization/f001"
}
}
],
"action": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "PSY"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "SPI"
}
]
},
{
"actor": [
},
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
"type": "permit",
"actor": [
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
}
]
},
"reference": {
"reference": "Organization/f001"
}
]
},
"reference": {
"reference": "Organization/f001"
}
}
],
"action": [
{
"coding": [
}
],
"action": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "SPI"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
"code": "N"
}
]
},
{
"actor": [
},
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
"type": "permit",
"actor": [
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
}
]
},
"reference": {
"reference": "Organization/f001"
}
]
},
"reference": {
"reference": "Organization/f001"
}
}
],
"action": [
{
"coding": [
}
],
"action": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
"code": "N"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "PSY"
}
]
},
{
"actor": [
},
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
"type": "permit",
"actor": [
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
}
]
},
"reference": {
"reference": "Organization/f001"
}
]
},
"reference": {
"reference": "Organization/f001"
}
}
],
"action": [
{
"coding": [
}
],
"action": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "PSY"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "SPI"
}
]
},
{
"actor": [
},
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
"type": "permit",
"actor": [
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
}
]
},
"reference": {
"reference": "Organization/f001"
}
]
},
"reference": {
"reference": "Organization/f001"
}
}
],
"action": [
{
"coding": [
}
],
"action": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "SPI"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "SEX"
}
]
},
{
"actor": [
},
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
"type": "permit",
"actor": [
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
}
]
},
"reference": {
"reference": "Organization/f001"
}
]
},
"reference": {
"reference": "Organization/f001"
}
}
],
"action": [
{
"coding": [
}
],
"action": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "SEX"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
"code": "N"
}
]
},
{
"actor": [
},
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
"type": "permit",
"actor": [
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
}
]
},
"reference": {
"reference": "Organization/f001"
}
]
},
"reference": {
"reference": "Organization/f001"
}
}
],
"action": [
{
"coding": [
}
],
"action": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
"code": "N"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "PSY"
}
]
},
{
"actor": [
},
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
"type": "permit",
"actor": [
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
}
]
},
"reference": {
"reference": "Organization/f001"
}
]
},
"reference": {
"reference": "Organization/f001"
}
}
],
"action": [
{
"coding": [
}
],
"action": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "PSY"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "SPI"
}
]
},
{
"actor": [
},
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
"actor": [
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
}
]
},
"reference": {
"reference": "Organization/f001"
}
]
},
"reference": {
"reference": "Organization/f001"
}
}
],
"action": [
{
"coding": [
}
],
"action": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "SPI"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "SEX"
}
]
},
{
"actor": [
},
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
"actor": [
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
}
]
},
"reference": {
"reference": "Organization/f001"
}
]
},
"reference": {
"reference": "Organization/f001"
}
}
],
"action": [
{
"coding": [
}
],
"action": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "SEX"
}
]
}
],
"securityLabel": [
},
{
"system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
"code": "N"
"type": "permit",
"actor": [
{
"role": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code": "PRCP"
}
]
},
"reference": {
"reference": "Organization/f001"
}
}
],
"action": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
"code": "N"
}
]
}
]
}
]
}
}
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
Release
4B
(v4.3.0)
hl7.fhir.r4b.core#4.3.0
R5
Ballot
hl7.fhir.core#5.0.0-ballot
generated
on
Sat,
May
28,
Sep
10,
2022
12:54+1000.
05:02+1000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Glossary
|
QA
Page
|
Compare
to
R4
R4B
|
Compare
to
R5
Draft
|
|
Propose
a
change