1. FHIR R4 APIs for Oracle Health Millennium Platform
  2. Tasks
  3. Consent

Get a consent by ID

get

/Consent/{ID}

Retrieves an individual consent by ID.

Note:
For consent read operations, both Consent.read and Patient.read scopes are required.

Request

Path Parameters
Header Parameters

  • The media type to be requested. Refer to what the resource's operation produces for what is supported.

    Example: application/fhir+json

  • Contains the credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.
Back to Top

Response

Supported Media Types

Default Response

This operation supports the following authorization types: Example Request: 
GET https://fhir-open.cerner.com/r4/ec2458f2-1e24-41c8-b71b-0e701af7583d/Consent/AR-12742397-12724066
Example Response: 
  
    {
      "resourceType": "Consent",
      "id": "AR-12742397-12724066",
      "meta": {
        "versionId": "126",
        "lastUpdated": "2024-09-19T15:00:43.000Z"
      },
      "text": {
        "status": "generated",
        "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Consent</b></p><p><b>Patient Name</b>: VAN, JEFFERSON</p><p><b>Status</b>: Active</p><p><b>Scope</b>: Privacy Consent</p><p><b>Category</b>: Patient Consent</p><p><b>Policy Rule</b>: Consent given for electronic record sharing (finding)</p><p><b>Consent Start Date</b>: Aug  2, 2024  5:00 A.M. UTC</p><p><b>Actor Name</b>: SMARTS II, NANCYS II</p><p><b>Actor Role</b>: Authorized Representative</p></div>"
      },
      "status": "active",
      "scope": {
        "coding": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/consentscope",
            "code": "patient-privacy",
            "display": "Privacy Consent"
          }
        ],
        "text": "Privacy Consent"
      },
      "category": [
        {
          "coding": [
            {
              "system": "http://loinc.org",
              "code": "59284-0",
              "display": "Patient Consent"
            }
          ],
          "text": "Patient Consent"
        }
      ],
      "patient": {
        "reference": "Patient/12742397",
        "display": "VAN, JEFFERSON"
      },
      "policyRule": {
        "coding": [
          {
            "system": "http://snomed.info/sct",
            "code": "425691002",
            "display": "Consent given for electronic record sharing (finding)"
          }
        ],
        "text": "Consent given for electronic record sharing (finding)"
      },
      "provision": {
        "type": "permit",
        "period": {
          "start": "2024-08-02T05:00:00.000Z"
        },
        "actor": [
          {
            "id": "12724066",
            "role": {
              "coding": [
                {
                  "system": "http://terminology.hl7.org/CodeSystem/v3-ParticipationFunction",
                  "code": "AUCG",
                  "display": "caregiver information receiver"
                }
              ],
              "text": "Authorized Representative"
            },
            "reference": {
              "reference": "RelatedPerson/12724066-12742397",
              "display": "SMARTS II, NANCYS II"
            }
          }
        ],
        "action": [
          {
            "coding": [
              {
                "system": "http://terminology.hl7.org/CodeSystem/consentaction",
                "code": "correct",
                "display": "Access and Correct"
              }
            ],
            "text": "Access and Correct"
          }
        ],
        "purpose": [
          {
            "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
            "code": "PurposeOfUse",
            "display": "purpose of use"
          }
        ]
      }
    }
Headers
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the X-Request-Id, if present.
  • Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the opc-Request-Id, if present.
Back to Top