FHIR R4 APIs for Oracle Health AI Application Suite

Get a list of consents

get

/Consent

Note: The FHIR API endpoints described below are available for customers to deploy and use. Developers are welcome and encouraged to develop against the specifications in anticipation of customer deployment.

Retrieves a list of consents that meet the supplied query parameters.

Do not combine _id with patient or consentor selectors.
Use category only with another supported selector.

Request

Query Parameters

__lastUpdated: array[string]

Maximum Number of Items: 2

The last updated date used to filter results.
_count: integer

Minimum Value: 1

Maximum Value: 128

The maximum number of results per page.

Default Value: 50
_id: string

The logical resource ID.
_include: array[string]
Maximum Number of Items: 2

Unique Items Required: true

Includes matching Patient and RelatedPerson resources.
- Allowed Values: [ "Consent:patient", "Consent:consentor" ]
```
[
    "Consent:patient",
    "Consent:consentor"
]
```
category: string

The consent category token.
consentor: string

The related person consentor reference or ID.
consentor.identifier: string

The consentor identifier.
patient: string

The patient reference or ID.
patient.identifier: string

The patient identifier.

Header Parameters

accept(required): string

The media type to be requested.

Example: application/fhir+json
authorization(required): string

The OAuth 2.0 Bearer token used to authenticate the request.

There's no request body for this operation.

Response

200 Response

The successful search response.

Root Schema : schema

Type: object

Show Source

entry: array entry
id(required): string
link: array link
resourceType(required): string

Allowed Values: [ "Bundle" ]
type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleEntryForConsent"
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

Array of: object BundleEntryForConsent

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleEntryForConsent"
    }
}

Nested Schema : link

Type: array

Show Source

Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : BundleEntryForConsent

Type: object

Show Source

fullUrl: string
resource: resource
search: object BundleEntrySearch

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string"
        },
        "resource":{
            "oneOf":[
                {
                    "$ref":"#/components/schemas/Consent"
                },
                {
                    "$ref":"#/components/schemas/PatientForConsent"
                },
                {
                    "$ref":"#/components/schemas/RelatedPersonForConsent"
                }
            ]
        },
        "search":{
            "$ref":"#/components/schemas/BundleEntrySearch"
        }
    }
}

Nested Schema : resource

Match One Schema

Show Source

object Consent

The FHIR R4 Consent resource.
object PatientForConsent

Additional Properties Allowed: true

The included FHIR Patient resource.
object RelatedPersonForConsent

Additional Properties Allowed: true

The included FHIR RelatedPerson resource.

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/Consent"
        },
        {
            "$ref":"#/components/schemas/PatientForConsent"
        },
        {
            "$ref":"#/components/schemas/RelatedPersonForConsent"
        }
    ]
}

Nested Schema : BundleEntrySearch

Type: object

Show Source

mode: string

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        }
    }
}

Nested Schema : Consent

Type: object

The FHIR R4 Consent resource.

Show Source

category(required): array category
id(required): string
meta: object meta
patient(required): object ReferenceForConsent
performer: array performer
policyRule(required): object CodeableConcept
resourceType(required): string

Allowed Values: [ "Consent" ]
scope(required): object CodeableConcept
status(required): string
text: object Narrative

{
    "type":"object",
    "description":"The FHIR R4 Consent resource.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Consent"
            ]
        },
        "id":{
            "type":"string"
        },
        "meta":{
            "type":"object",
            "properties":{
                "versionId":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "security":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/Coding"
                    }
                }
            }
        },
        "text":{
            "$ref":"#/components/schemas/Narrative"
        },
        "status":{
            "type":"string"
        },
        "scope":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "category":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CodeableConcept"
            }
        },
        "patient":{
            "$ref":"#/components/schemas/ReferenceForConsent"
        },
        "performer":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ReferenceForConsent"
            }
        },
        "policyRule":{
            "$ref":"#/components/schemas/CodeableConcept"
        }
    },
    "required":[
        "resourceType",
        "id",
        "status",
        "scope",
        "category",
        "patient",
        "policyRule"
    ]
}

Nested Schema : PatientForConsent

Type: object

Additional Properties Allowed: true

The included FHIR Patient resource.

Show Source

resourceType: string

Allowed Values: [ "Patient" ]

{
    "type":"object",
    "description":"The included FHIR Patient resource.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Patient"
            ]
        }
    },
    "additionalProperties":true
}

Nested Schema : RelatedPersonForConsent

Type: object

Additional Properties Allowed: true

The included FHIR RelatedPerson resource.

Show Source

resourceType: string

Allowed Values: [ "RelatedPerson" ]

{
    "type":"object",
    "description":"The included FHIR RelatedPerson resource.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "RelatedPerson"
            ]
        }
    },
    "additionalProperties":true
}

Nested Schema : category

Type: array

Show Source

Array of: object CodeableConcept

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CodeableConcept"
    }
}

Nested Schema : meta

Type: object

Show Source

lastUpdated: string (date-time)
security: array security
versionId: string

{
    "type":"object",
    "properties":{
        "versionId":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "security":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        }
    }
}

Nested Schema : ReferenceForConsent

Type: object

Show Source

display: string
reference: string
type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : performer

Type: array

Show Source

Array of: object ReferenceForConsent

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ReferenceForConsent"
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

coding: array coding

The terminology codings or data-absent-reason coding.
id: string
text: string

The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : Narrative

Type: object

Show Source

div: string

The XHTML narrative content.
status: string

The narrative generation status.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"The narrative generation status."
        },
        "div":{
            "type":"string",
            "description":"The XHTML narrative content."
        }
    }
}

Nested Schema : security

Type: array

Show Source

Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Coding

Type: object

Show Source

code: string
display: string
system: string
userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : BundleLink

Type: object

Show Source

relation: string

Allowed Values: [ "self", "next", "previous" ]

The link relation.
url: string

The link URL.

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ],
            "description":"The link relation."
        },
        "url":{
            "type":"string",
            "description":"The link URL."
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Root Schema : OperationOutcome

Type: object

The FHIR OperationOutcome.

Show Source

issue: array issue

The OperationOutcome issues.
resourceType: string

Allowed Values: [ "OperationOutcome" ]

The FHIR resource type.

{
    "type":"object",
    "description":"The FHIR OperationOutcome.",
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ],
            "description":"The FHIR resource type."
        },
        "issue":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OperationOutcomeIssue"
            },
            "description":"The OperationOutcome issues."
        }
    }
}

Nested Schema : issue

Type: array

The OperationOutcome issues.

Show Source

Array of: object OperationOutcomeIssue

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/OperationOutcomeIssue"
    },
    "description":"The OperationOutcome issues."
}

Nested Schema : OperationOutcomeIssue

Type: object

Show Source

code: string
details: object CodeableConcept
diagnostics: string
expression: array expression
severity: string

{
    "type":"object",
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "details":{
            "$ref":"#/components/schemas/CodeableConcept"
        },
        "diagnostics":{
            "type":"string"
        },
        "expression":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

coding: array coding

The terminology codings or data-absent-reason coding.
id: string
text: string

The human-readable medication name.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            },
            "description":"The terminology codings or data-absent-reason coding."
        },
        "text":{
            "type":"string",
            "description":"The human-readable medication name."
        }
    }
}

Nested Schema : expression

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : coding

Type: array

The terminology codings or data-absent-reason coding.

Show Source

Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    },
    "description":"The terminology codings or data-absent-reason coding."
}

Nested Schema : Coding

Type: object

Show Source

code: string
display: string
system: string
userSelected: boolean

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        },
        "userSelected":{
            "type":"boolean"
        }
    }
}