Consent - FHIR Resource (r4)
This Consent Resource uses the FHIR API standard for access and structure.
Validate an Consent FHIR Resource (r4)
Consent Attributes
AttributeField is listTypeDescription
Description: Identifier for this record (external references)
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Consent) identifier FHIR attribute
Description: draft | proposed | active | rejected | inactive | entered-in-error
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (Consent) status FHIR attribute
Description: Which of the four areas this resource covers (extensible)
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"scope": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/consentscope",
"code": "patient-privacy"
}
]
}Learn more about the (Consent) scope FHIR attribute
Description: Classification of the consent statement - for indexing/retrieval
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "59284-0"
}
]
}
]Learn more about the (Consent) category FHIR attribute
Description: Who the consent applies to
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patient": {
"reference": "Patient/f001",
"display": "P. van de Heuvel"
}Learn more about the (Consent) patient FHIR attribute
Description: When this Consent was created or indexed
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"dateTime": "2016-05-11"Learn more about the (Consent) dateTime FHIR attribute
Description: "performer" : [{ Reference(Organization|Patient|Practitioner|RelatedPerson|
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"performer": Learn more about the (Consent) performer FHIR attribute
Description: Custodian of the consent
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"organization": [
{
"reference": "Organization/f001"
}
]Learn more about the (Consent) organization FHIR attribute
Description:
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"source[x]": Learn more about the (Consent) source[x] FHIR attribute
Description: Policies covered by this consent
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"policy": Learn more about the (Consent) policy FHIR attribute
Description: C? Regulation that this consents to
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"policyRule": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "OPTIN"
}
]
}Learn more about the (Consent) policyRule FHIR attribute
Description: Consent Verified by patient or family
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"verification": Learn more about the (Consent) verification FHIR attribute
Description: Constraints to the base Consent.policyRule
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"provision": {
"period": {
"start": "1964-01-01",
"end": "2016-01-01"
}
}Learn more about the (Consent) provision FHIR attribute
Consent Example
{
"resourceType": "Consent",
"id": "consent-example-basic",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n\t\t\t<p>\n\tAuthorize Normal access for Treatment\n\t\t\t</p>\n\t\t\t<p>\n Patient "P. van de Heuvel" wishes to have all of the PHI collected at the Good Health Psychiatric Hospital \n available for normal treatment use.\n\t\t\t</p>\n\t\t</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": {
"reference": "Patient/f001",
"display": "P. van de Heuvel"
},
"dateTime": "2016-05-11",
"organization": [
{
"reference": "Organization/f001"
}
],
"sourceAttachment": {
"title": "The terms of the consent in lawyer speak."
},
"policyRule": {
"coding": [
{
"system": "http://terminology.hl7.org/CodeSystem/v3-ActCode",
"code": "OPTIN"
}
]
},
"provision": {
"period": {
"start": "1964-01-01",
"end": "2016-01-01"
}
}
}Consent Structure
{
"resourceType" : "Consent",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Identifier for this record (external references)
"status" : "<code>", // R! draft | proposed | active | rejected | inactive | entered-in-error
"scope" : { CodeableConcept }, // R! Which of the four areas this resource covers (extensible)
"category" : [{ CodeableConcept }], // R! Classification of the consent statement - for indexing/retrieval
"patient" : { Reference(Patient) }, // Who the consent applies to
"dateTime" : "<dateTime>", // When this Consent was created or indexed
"performer" : [{ Reference(Organization|Patient|Practitioner|RelatedPerson|
PractitionerRole) }], // Who is agreeing to the policy and rules
"organization" : [{ Reference(Organization) }], // Custodian of the consent
// source[x]: Source from which this consent is taken. One of these 2:
"sourceAttachment" : { Attachment },
"sourceReference" : { Reference(Consent|DocumentReference|Contract|
QuestionnaireResponse) },
"policy" : [{ // Policies covered by this consent
"authority" : "<uri>", // C? Enforcement source for policy
"uri" : "<uri>" // C? Specific policy covered by this consent
}],
"policyRule" : { CodeableConcept }, // C? Regulation that this consents to
"verification" : [{ // Consent Verified by patient or family
"verified" : <boolean>, // R! Has been verified
"verifiedWith" : { Reference(Patient|RelatedPerson) }, // Person who verified
"verificationDate" : "<dateTime>" // When consent verified
}],
"provision" : { // Constraints to the base Consent.policyRule
"type" : "<code>", // deny | permit
"period" : { Period }, // Timeframe for this rule
"actor" : [{ // Who|what controlled by this rule (or group, by role)
"role" : { CodeableConcept }, // R! How the actor is involved
"reference" : { Reference(Device|Group|CareTeam|Organization|Patient|
Practitioner|RelatedPerson|PractitionerRole) } // R! Resource for the actor (or group, by role)
}],
"action" : [{ CodeableConcept }], // Actions controlled by this rule
"securityLabel" : [{ Coding }], // Security Labels that define affected resources
"purpose" : [{ Coding }], // Context of activities covered by this rule
"class" : [{ Coding }], // e.g. Resource Type, Profile, CDA, etc.
"code" : [{ CodeableConcept }], // e.g. LOINC or SNOMED CT code, etc. in the content
"dataPeriod" : { Period }, // Timeframe for data controlled by this rule
"data" : [{ // Data controlled by this rule
"meaning" : "<code>", // R! instance | related | dependents | authoredby
"reference" : { Reference(Any) } // R! The actual data reference
}],
"provision" : [{ Content as for Consent.provision }] // Nested Exception Rules
}
}
Consent Search Parameters
The following search parameters can be used to query Consent resources. Just submit them like so:
https://api.1up.health/fhir/r4/Consent?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
action | text | provision.action |
actor | reference | provision.actor.reference |
category | text | category |
consentor | reference | performer |
data | reference | provision.data.reference |
date | date | dateTime |
identifier | text | identifier |
organization | reference | organization |
patient | reference | patient |
period | date | provision.period |
purpose | text | provision.purpose |
scope | text | scope |
security-label | text | provision.securityLabel |
source-reference | reference | source |
status | text | status |
