Security
and
Privacy
This
page
is
part
of
the
Continuous
Integration
Build
of
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
(will
be
available
incorrect/inconsistent
at
this
URL).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
times).
See
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
| Responsible Owner: Community Based Collaborative Care Work Group | Standards Status : Informative | Compartments : Group , 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>"
"resourceType" : "Consent",
"id" : "consent-example-pkb",
"text" : {
"status" : "generated",
"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"
}
]
"status" : "active",
"category" : [{
"coding" : [{
"system" : "http://loinc.org",
"code" : "59284-0"
}]
}],
"subject" : {
"reference" : "Patient/example",
"display" : "Peter James Chalmers"
},
"category": [
"date" : "2018-12-28",
"controller" : [{
"reference" : "Organization/f001"
}],
"regulatoryBasis" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code" : "INFA"
}]
}],
"decision" : "deny",
"provision" : [{
"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"
}],
"provision" : [{
"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"
}]
},
{
"coding": [
{
"system": "http://loinc.org",
"code": "59284-0"
"actor" : [{
"role" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code" : "PRCP"
}]
},
"reference" : {
"reference" : "Organization/f001"
}
]
}
],
"patient": {
"reference": "Patient/example",
"display": "...example patient..."
},
"dateTime": "2016-06-16",
"organization": [
}],
"action" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/consentaction",
"code" : "access"
}]
}],
"securityLabel" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code" : "SPI"
}]
},
{
"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"
}
]
"actor" : [{
"role" : {
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
"code" : "PRCP"
}]
},
"reference": {
"reference": "Organization/f001"
"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"
}
],
"provision": [
{
"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"
}
}
],
"action": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "SPI"
}
]
},
{
"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"
}
]
},
{
"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"
}
}
],
"action": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "SPI"
}
]
},
{
"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": "SEX"
}
]
},
{
"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"
}
]
},
{
"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"
}
}
],
"action": [
{
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentaction",
"code": "access"
}
]
}
],
"securityLabel": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "SPI"
}
]
},
{
"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": "SEX"
}
]
},
{
"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"
}
]
}
]
}
}],
"action" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/consentaction",
"code" : "access"
}]
}],
"securityLabel" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-Confidentiality",
"code" : "N"
}]
},
{
"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"
}
}],
"action" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/consentaction",
"code" : "access"
}]
}],
"securityLabel" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code" : "SPI"
}]
},
{
"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" : "SEX"
}]
},
{
"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"
}]
},
{
"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"
}
}],
"action" : [{
"coding" : [{
"system" : "http://terminology.hl7.org/CodeSystem/consentaction",
"code" : "access"
}]
}],
"securityLabel" : [{
"system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code" : "SPI"
}]
},
{
"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" : "SEX"
}]
},
{
"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
4
(Technical
Correction
#1)
(v4.0.1)
R6
hl7.fhir.core#6.0.0-ballot3
generated
on
Fri,
Mon,
Nov
1,
2019
09:34+1100.
QA
Page
10,
2025
15:21+0000.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
Glossary
|
QA
|
Compare
to
R3
R4
|
Compare
to
R5
|
Compare
to
Last
Ballot
|
|
Propose
a
change