Consent - FHIR Resource (r4)


This Consent Resource uses the FHIR API standard for access and structure.

Validate an Consent FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
categorytrueCodeableConcept# Classification of the consent statement - for indexing/retrieval
dateTimefalsedateTime# When this Consent was created or indexed
identifiertrueIdentifier# Identifier for this record (external references)
organizationtrueReference# Custodian of the consent
patientfalseReference# Who the consent applies to
performertrueReference# "performer" : [{ Reference(Organization|Patient|Practitioner|RelatedPerson|
policytrueData Type# Policies covered by this consent
policyRulefalseCodeableConcept# C? Regulation that this consents to
provisionfalseData Type# Constraints to the base Consent.policyRule
scopefalseCodeableConcept# Which of the four areas this resource covers (extensible)
source[x]falseReference#undefined
statusfalsecode# draft | proposed | active | rejected | inactive | entered-in-error
verificationtrueData Type# Consent Verified by patient or family

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 &quot;P. van de Heuvel&quot; 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 ParameterField TypeResource Fields Searched
actiontextprovision.action
actorreferenceprovision.actor.reference
categorytextcategory
consentorreferenceperformer
datareferenceprovision.data.reference
datedatedateTime
identifiertextidentifier
organizationreferenceorganization
patientreferencepatient
perioddateprovision.period
purposetextprovision.purpose
scopetextscope
security-labeltextprovision.securityLabel
source-referencereferencesource
statustextstatus