Consent - FHIR Resource (stu3)


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

Validate an Consent FHIR Resource (stu3)



Resource Attributes

AttributeField is listTypeDescription
actiontrueCodeableConcept# Actions controlled by this consent
actortrueData Type# Who|what controlled by this consent (or group, by role)
categorytrueCodeableConcept# Classification of the consent statement - for indexing/retrieval
consentingPartytrueReference# "consentingParty" : [{ Reference(Organization|Patient|Practitioner|
datatrueData Type# Data controlled by this consent
dataPeriodfalsePeriod# Timeframe for data controlled by this consent
dateTimefalsedateTime# When this Consent was created or indexed
excepttrueData Type# Additional rule - addition or removal of permissions
identifierfalseIdentifier# Identifier for this record (external references)
organizationtrueReference# Custodian of the consent
patientfalseReference# Who the consent applies to
periodfalsePeriod# Period that this consent applies
policytrueData Type# Policies covered by this consent
policyRulefalseuri# C? Policy that this consents to
purposetrueCoding# Context of activities for which the agreement is made
securityLabeltrueCoding# Security Labels that define affected resources
sourceAttachmentfalseAttachment# "sourceAttachment" : { Attachment },
sourceIdentifierfalseIdentifier# "sourceIdentifier" : { Identifier },
sourceReferencefalseReference# "sourceReference" : { Reference(Consent|DocumentReference|Contract|
statusfalsecode# draft | proposed | active | rejected | inactive | entered-in-error

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 &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   </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 the like so:

https://api.1up.health/fhir/stu3/Consent?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
actiontextaction, except.action
actorreferenceactor.reference, except.actor.reference
categorytextcategory
consentorreferenceconsentingParty
datareferencedata.reference, except.data.reference
datedatedateTime
identifiertextidentifier
organizationreferenceorganization
patientreferencepatient
perioddateperiod
purposetextpurpose, except.purpose
securitylabeltextsecurityLabel, except.securityLabel
sourcereferencesource
statustextstatus