Consent read

get/Consent/{id}

Page View

This resource contains the legally binding requirements for any type of healthcare consent. Patient consent may be related to privacy, medical treatment, research, or advance care (e.g., DNR).

You can review or retrieve consent information.

Supported fields and schema examples

We support any valid FHIR® field. However, we only display fields we’ve defined in our schema, which are usually based on what’s included in the U.S. Core profile. We recommend relying on U.S. Core requirements.

Our schema examples show the shape and possibility of each FHIR® resource; they aren’t code for real-time API calls. We don’t currently recommend copying and pasting these schema examples for your API calls. Consider reviewing FHIR® API actions for realistic examples for particular use cases.

read

This interaction allows you to review a specific Consent resource with details about a patient's permission or agreement to receive healthcare services.

FHIR read

To use a read interaction, you must know the related resource ID, which you may not have in your real workflows. A read is likely only a follow-up option after receiving the specific resource in a recent FHIR® passthrough or data on demand exchange.

Typically, you should use the more flexible _search with query parameters, unless you're guaranteed to request data directly from a FHIR® server using the resource ID. Learn more about using FHIR® identifiers.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/fhir/R4/{destinationSlug}/{environmentFlag}/Consent/{id}' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN'

Request Parameters

id
required, string
Consent identifier

Response fields and example

Example payload generated from schema

1
{
2
  "resourceType": "Consent",
3
  "id": "string",
4
  "identifier": [
5
    {
6
      "extension": [
7
        {
8
          "url": "string",
9
          "valueBoolean": true
10
        }
11
      ],
12
      "use": "usual",
13
      "system": "string",
14
      "value": "string"
15
    }
16
  ],
17
  "status": "draft",
18
  "scope": {
19
    "coding": [
20
      {
21
        "system": "string",
22
        "code": "string"
23
      }
24
    ],
25
    "text": "string"
26
  },
27
  "category": [
28
    {
29
      "coding": [
30
        {
31
          "system": "string",
32
          "code": "string"
33
        }
34
      ],
35
      "text": "string"
36
    }
37
  ],
38
  "patient": {
39
    "reference": "string"
40
  },
41
  "organization": [
42
    {
43
      "reference": "string"
44
    }
45
  ],
46
  "policyRule": {
47
    "extension": [
48
      {
49
        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
50
        "valueCode": "unsupported"
51
      }
52
    ]
53
  },
54
  "verification": [
55
    {
56
      "verified": true,
57
      "verifiedWith": {
58
        "reference": "string"
59
      },
60
      "verificationDate": "string"
61
    }
62
  ],
63
  "provision": {
64
    "period": {
65
      "start": "string",
66
      "end": "string"
67
    },
68
    "code": [
69
      {
70
        "coding": [
71
          {
72
            "system": "string",
73
            "code": "string"
74
          }
75
        ],
76
        "text": "string"
77
      }
78
    ]
79
  },
80
  "sourceAttachment": {
81
    "url": "string"
82
  }
83
}

A profile on the Consent resource that conforms to Redox requirements.

resourceType
required, string
Identifies the type of the resource
Value: Consent
status
required, string
Indicates the current state of this consent.
Possible Values: draft, proposed, active, rejected, inactive, entered-in-error
scope
required, object
A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible.
- coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
category
required, Array of object
A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
- coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
- text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
policyRule
required, object
policyRule is unsupported, but required by FHIR.
- extension
  Array of object
  Identifies this field as unsupported
  url
  required, string
  Source of the definition for the extension code - a logical name or a URL.
  Value: http://hl7.org/fhir/StructureDefinition/data-absent-reason
  valueCode
  required, string
  The reason a required field is missing
  Value: unsupported
id
string
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
identifier
Array of object
Unique identifier for this copy of the Consent Statement.
- extension
  Array of Boolean, String, CodeableConcept, Coding
  May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
  One of:
  url
  required, string
  Source of the definition for the extension code - a logical name or a URL.
  valueBoolean
  boolean
  A single value for the extension.
- use
  string
  The purpose of this identifier.
  Possible Values: usual, official, temp, secondary, old (If known)
- system
  string
  Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
- value
  string
  The portion of the identifier typically relevant to the user and which is unique within the context of the system.
patient
object
The patient/healthcare consumer to whom this consent applies.

Must be a resource of type Patient.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
organization
Array of object
The custodian organization(s) that manage the consent, and the framework within which it is executed.

Must be a resource of type Organization.
- reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
verification
Array of object
Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person.
- verified
  required, boolean
  Has the instruction been verified.
- verifiedWith
  object
  Who verified the instruction (Patient, Relative or other Authorized Person).
  
  Must be a resource of type RelatedPerson.
  reference
  string
  A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with # and refers to a contained resource.
- verificationDate
  string
  Date verification was collected.
provision
object
An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.
- period
  object
  The timeframe in this rule is valid.
  start
  string
  The start of the period. The boundary is inclusive.
  end
  string
  The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time.
- code
  Array of object
  If this code is found in an instance, then the rule applies.
  coding
  Array of object
  A reference to a code defined by a terminology system.
  system
  string
  The identification of the code system that defines the meaning of the symbol in the code.
  code
  string
  A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).
  text
  string
  A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
sourceAttachment
object
The source on which this consent statement is based. The source might be a scanned original paper form, or a reference to a consent that links back to such a source, a reference to a document repository (e.g. XDS) that stores the original consent document.
- url
  string
  A location where the data can be accessed.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.