Consent REST Endpoints

Sort by

Task Path Method

Description

Consent

This topic describes information for the Consent resource.

Overview

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.

The Consent resource represents a patient's privacy consent. This API returns privacy consents that authorize related people to access the patient's electronic health record (EHR) data.

Profile Support

US Core 6.1.0 does not define a standalone Consent profile. This API uses the base FHIR R4 Consent resource.

Note:

The examples provided here are nonnormative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Returned Fields

Element	Type
Consent	DomainResource
Consent.id	id
Consent.meta	Meta
Consent.text	Narrative
Consent.status	code
Consent.scope	CodeableConcept
Consent.category	CodeableConcept
Consent.patient	Reference(Patient)
Consent.performer	Reference(RelatedPerson)
Consent.policyRule	CodeableConcept

Terminology Bindings

Element	Description	Details
Consent.status	The state of the consent.	Consent State
Consent.scope	The scope of the consent.	Consent Scope
Consent.category	The type of consent statement.	Consent Category Codes
Consent.policyRule	The policy covered by the consent.	Consent PolicyRule Codes

Consent

The operations from the Consent category.

Get a consent by ID

Method: get

Path: /Consent/{id}

Get a list of consents

Method: get

Path: /Consent