The Consent resource implements the FHIR R4 Consent specification

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*   Identifier for this record (external references)
status code 1..1 * draft | proposed | active | rejected | inactive | entered-in-error ConsentState (Required)
scope CodeableConcept 1..1 * Which of the four areas this resource covers (extensible) Consent Scope Codes (Extensible)
category CodeableConcept 1..* * Classification of the consent statement - for indexing/retrieval Consent Category Codes (Extensible)
patient Reference 0..1   (Patient) Who the consent applies to
dateTime dateTime 0..1   When this Consent was created or indexed
performer Reference (Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) 0..*   Who is agreeing to the policy and rules
organization Reference (Organization) 0..*   Custodian of the consent
sourceAttachment Attachment 0..1   Source from which this consent is taken
sourceReference Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) 0..1   Source from which this consent is taken
policy Consent.Policy 0..*   Policies covered by this consent
policy.uri uri 0..1   Specific policy covered by this consent
policyRule CodeableConcept 0..1   Regulation that this consents to Consent PolicyRule Codes (Extensible)
provision Consent.Provision 0..1   Constraints to the base Consent.policyRule
provision.type code 0..1   deny | permit | ConsentProvisionType (Required)
provision.period Period 0..1   Timeframe for this rule
provision.actor BackboneElement 0..*   Who|what controlled by this rule (or group, by role)
provision.role CodeableConcept 1..1 * How the actor is involved SecurityRoleType (Extensible)
provision.reference Reference (Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) 1..1 * Resource for the actor (or group, by role)
provision.action CodeableConcept 0..*   Actions controlled by this rule Consent Action Codes (Example)
provision.securityLabel Coding 0..*   Security Labels that define affected resources \n SecurityLabels (Extensible)
provision.purpose Coding 0..*   Context of activities covered by this rule V3 Value SetPurposeOfUse (Extensible)
provision.class Coding 0..*   e.g. Resource Type, Profile, CDA, etc. Consent Content Class (Extensible)
provision.code CodeableConcept 0..*   e.g. LOINC or SNOMED CT code, etc. in the content Consent Content Codes (Example)
provision.dataPeriod Period 0..1   Timeframe for data controlled by this rule
provision.data BackboneElement 0..*   Data controlled by this rule
provision.meaning code 1..1 * instance | related | dependents | authoredby ConsentDataMeaning (Required)
provision.reference Reference (Any) 1..1 * The actual data reference
provision.provision see provision 0..*   Nested Exception Rules

Interactions

Read

Get a Consent entry by id

GET /Consent/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/Consent/123456ce-fbb8-a37c-e208-a15cf06f5226

Response

{
  "resourceType": "Consent",
  "id": "consent-example-smartonfhir",
  "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": "2015-11-18",
  "organization": [
    {
      "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": "CST"
            }
          ]
        },
        "reference": {
          "reference": "Organization/f001"
        }
      },
      {
        "role": {
          "coding": [
            {
              "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationType",
              "code": "PRCP"
            }
          ]
        },
        "reference": {
          "reference": "Patient/example",
          "display": "Good Health Clinic"
        }
      }
    ],
    "action": [
      {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/consentaction",
            "code": "access"
          }
        ]
      }
    ]
  }
}

Query Consent resources

GET /Consent?:query_parameters

Example

Request

https://r4cert.medicasoft.us/api/fhir/Consent?patient=Patient/<patient_id>

Parameters

Name Type Description
patient reference Who the consent applies to
category token Classification of the consent statement - for indexing/retrieval

Errors

Code Description
400 Invalid parameters
404 Resource not found