Consent - FHIR Resource (stu3)
This Consent Resource uses the FHIR API standard for access and structure.
Validate an Consent FHIR Resource (stu3)
Consent Attributes
AttributeField is listTypeDescription
Description: draft | proposed | active | rejected | inactive | entered-in-error
FHIR Version: stu3
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: Classification of the consent statement - for indexing/retrieval
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"category": Learn more about the (Consent) category FHIR attribute
Description: Custodian of the consent
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"organization": [
{
"display": "Canada Infoway",
"reference": "Organization/Infoway"
}
]Learn more about the (Consent) organization FHIR attribute
Description: Who the consent applies to
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patient": {
"display": "P. van de Heuvel",
"reference": "Patient/f001"
}Learn more about the (Consent) patient FHIR attribute
Description: "sourceAttachment" : { Attachment },
FHIR Version: stu3
Attribute Type : Attachment
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"sourceAttachment": {
"title": "The terms of the consent in lawyer speak."
}Learn more about the (Consent) sourceAttachment FHIR attribute
Description: "consentingParty" : [{ Reference(Organization|Patient|Practitioner|
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"consentingParty": Learn more about the (Consent) consentingParty FHIR attribute
Description: Period that this consent applies
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"period": {
"start": "1964-01-01",
"end": "2016-01-01"
}Learn more about the (Consent) period FHIR attribute
Description: Who|what controlled by this consent (or group, by role)
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"actor": Learn more about the (Consent) actor FHIR attribute
Description: When this Consent was created or indexed
FHIR Version: stu3
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: "sourceReference" : { Reference(Consent|DocumentReference|Contract|
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"sourceReference": Learn more about the (Consent) sourceReference FHIR attribute
Description: Additional rule - addition or removal of permissions
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"except": Learn more about the (Consent) except FHIR attribute
Description: C? Policy that this consents to
FHIR Version: stu3
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"policyRule": "http://goodhealth.org/consent/policy/opt-in"Learn more about the (Consent) policyRule FHIR attribute
Description: Timeframe for data controlled by this consent
FHIR Version: stu3
Attribute Type : Period
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"dataPeriod": Learn more about the (Consent) dataPeriod FHIR attribute
Description: Policies covered by this consent
FHIR Version: stu3
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: Security Labels that define affected resources
FHIR Version: stu3
Attribute Type : Coding
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"securityLabel": Learn more about the (Consent) securityLabel FHIR attribute
Description: "sourceIdentifier" : { Identifier },
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"sourceIdentifier": Learn more about the (Consent) sourceIdentifier FHIR attribute
Description: Identifier for this record (external references)
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": Learn more about the (Consent) identifier FHIR attribute
Description: Data controlled by this consent
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"data": Learn more about the (Consent) data FHIR attribute
Description: Actions controlled by this consent
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"action": Learn more about the (Consent) action FHIR attribute
Description: Context of activities for which the agreement is made
FHIR Version: stu3
Attribute Type : Coding
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"purpose": Learn more about the (Consent) purpose FHIR attribute
Consent Example
{
"status": "active",
"patient": {
"display": "P. van de Heuvel",
"reference": "Patient/f001"
},
"resourceType": "Consent",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>\n\tAuthorize Normal access for Treatment\n\t</p><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 </p>\n </div>"
},
"period": {
"start": "1964-01-01",
"end": "2016-01-01"
},
"policyRule": "http://goodhealth.org/consent/policy/opt-in",
"dateTime": "2016-05-11",
"sourceAttachment": {
"title": "The terms of the consent in lawyer speak."
},
"organization": [
{
"display": "Canada Infoway",
"reference": "Organization/Infoway"
}
],
"id": "consent-example-basic"
}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
"category" : [{ CodeableConcept }], // Classification of the consent statement - for indexing/retrieval
"patient" : { Reference(Patient) }, // R! Who the consent applies to
"period" : { Period }, // Period that this consent applies
"dateTime" : "<dateTime>", // When this Consent was created or indexed
"consentingParty" : [{ Reference(Organization|Patient|Practitioner|
RelatedPerson) }], // Who is agreeing to the policy and exceptions
"actor" : [{ // Who|what controlled by this consent (or group, by role)
"role" : { CodeableConcept }, // R! How the actor is involved
"reference" : { Reference(Device|Group|CareTeam|Organization|Patient|
Practitioner|RelatedPerson) } // R! Resource for the actor (or group, by role)
}],
"action" : [{ CodeableConcept }], // Actions controlled by this consent
"organization" : [{ Reference(Organization) }], // Custodian of the consent
// source[x]: Source from which this consent is taken. One of these 3:
"sourceAttachment" : { Attachment },
"sourceIdentifier" : { Identifier },
"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" : "<uri>", // C? Policy that this consents to
"securityLabel" : [{ Coding }], // Security Labels that define affected resources
"purpose" : [{ Coding }], // Context of activities for which the agreement is made
"dataPeriod" : { Period }, // Timeframe for data controlled by this consent
"data" : [{ // Data controlled by this consent
"meaning" : "<code>", // R! instance | related | dependents | authoredby
"reference" : { Reference(Any) } // R! The actual data reference
}],
"except" : [{ // Additional rule - addition or removal of permissions
"type" : "<code>", // R! deny | permit
"period" : { Period }, // Timeframe for this exception
"actor" : [{ // Who|what controlled by this exception (or group, by role)
"role" : { CodeableConcept }, // R! How the actor is involved
"reference" : { Reference(Device|Group|CareTeam|Organization|Patient|
Practitioner|RelatedPerson) } // R! Resource for the actor (or group, by role)
}],
"action" : [{ CodeableConcept }], // Actions controlled by this exception
"securityLabel" : [{ Coding }], // Security Labels that define affected resources
"purpose" : [{ Coding }], // Context of activities covered by this exception
"class" : [{ Coding }], // e.g. Resource Type, Profile, or CDA etc
"code" : [{ Coding }], // e.g. LOINC or SNOMED CT code, etc in the content
"dataPeriod" : { Period }, // Timeframe for data controlled by this exception
"data" : [{ // Data controlled by this exception
"meaning" : "<code>", // R! instance | related | dependents | authoredby
"reference" : { Reference(Any) } // R! The actual data reference
}]
}]
}
Consent Search Parameters
The following search parameters can be used to query Consent resources. Just submit them like so:
https://api.1up.health/fhir/stu3/Consent?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
action | text | action, except.action |
actor | reference | actor.reference, except.actor.reference |
category | text | category |
consentor | reference | consentingParty |
data | reference | data.reference, except.data.reference |
date | date | dateTime |
identifier | text | identifier |
organization | reference | organization |
patient | reference | patient |
period | date | period |
purpose | text | purpose, except.purpose |
securitylabel | text | securityLabel, except.securityLabel |
source | reference | source |
status | text | status |
