consents

Create Consent

post
/organizations/{organizationId}/fhir/3/Consent

A record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringConsentThis is a Consent resource
identifierIdentifierUnique identifier for this copy of the Consent Statement.
statusstringdraft|proposed|active|rejected|inactive|entered-in-errorIndicates the current state of this consent.
categoryarray(CodeableConcept)A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
patient*ReferenceThe patient/healthcare consumer to whom this consent applies.
periodPeriodRelevant time or time-period when this Consent is applicable.
dateTimestringWhen this Consent was issued / created / indexed.
consentingPartyarray(Reference)Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
actorarray(Consent_Actor)Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
actionarray(CodeableConcept)Actions controlled by this consent.
organizationarray(Reference)The organization that manages the consent, and the framework within which it is executed.
sourceAttachmentAttachmentThe 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.
sourceIdentifierIdentifierThe 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.
sourceReferenceReferenceThe 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.
policyarray(Consent_Policy)The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
policyRulestringA referece to the specific computable policy.
securityLabelarray(Coding)A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.
purposearray(Coding)The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.
dataPeriodPeriodClinical or Operational Relevant period of time that bounds the data controlled by this consent.
dataarray(Consent_Data)The resources controlled by this consent, if specific resources are referenced.
exceptarray(Consent_Except)An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

Response

Patch Consent

patch
/organizations/{organizationId}/fhir/3/Consent/{resourceId}

A record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringConsentThis is a Consent resource
identifierIdentifierUnique identifier for this copy of the Consent Statement.
statusstringdraft|proposed|active|rejected|inactive|entered-in-errorIndicates the current state of this consent.
categoryarray(CodeableConcept)A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
patient*ReferenceThe patient/healthcare consumer to whom this consent applies.
periodPeriodRelevant time or time-period when this Consent is applicable.
dateTimestringWhen this Consent was issued / created / indexed.
consentingPartyarray(Reference)Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
actorarray(Consent_Actor)Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
actionarray(CodeableConcept)Actions controlled by this consent.
organizationarray(Reference)The organization that manages the consent, and the framework within which it is executed.
sourceAttachmentAttachmentThe 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.
sourceIdentifierIdentifierThe 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.
sourceReferenceReferenceThe 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.
policyarray(Consent_Policy)The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
policyRulestringA referece to the specific computable policy.
securityLabelarray(Coding)A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.
purposearray(Coding)The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.
dataPeriodPeriodClinical or Operational Relevant period of time that bounds the data controlled by this consent.
dataarray(Consent_Data)The resources controlled by this consent, if specific resources are referenced.
exceptarray(Consent_Except)An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

Response

Read Consent

get
/organizations/{organizationId}/fhir/3/Consent/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Consent

get
/organizations/{organizationId}/fhir/3/Consent/{resourceId}/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Consent

get
/organizations/{organizationId}/fhir/3/Consent/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Consent

delete
/organizations/{organizationId}/fhir/3/Consent/{resourceId}

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Consent

get
/organizations/{organizationId}/fhir/3/Consent

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
actionstring
actorstring
categorystring
consentorstring
datastring
datestring
identifierstring
organizationstring
patientstring
periodstring
purposestring
securitylabelstring
sourcestring
statusstring

Params

organizationId*string|stringid|slug

Response

Search History Consent

get
/organizations/{organizationId}/fhir/3/Consent/_history

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Consent

post
/organizations/{organizationId}/fhir/3/Consent/_search

A record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
actionstring
actorstring
categorystring
consentorstring
datastring
datestring
identifierstring
organizationstring
patientstring
periodstring
purposestring
securitylabelstring
sourcestring
statusstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringConsentThis is a Consent resource
identifierIdentifierUnique identifier for this copy of the Consent Statement.
statusstringdraft|proposed|active|rejected|inactive|entered-in-errorIndicates the current state of this consent.
categoryarray(CodeableConcept)A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
patient*ReferenceThe patient/healthcare consumer to whom this consent applies.
periodPeriodRelevant time or time-period when this Consent is applicable.
dateTimestringWhen this Consent was issued / created / indexed.
consentingPartyarray(Reference)Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
actorarray(Consent_Actor)Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
actionarray(CodeableConcept)Actions controlled by this consent.
organizationarray(Reference)The organization that manages the consent, and the framework within which it is executed.
sourceAttachmentAttachmentThe 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.
sourceIdentifierIdentifierThe 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.
sourceReferenceReferenceThe 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.
policyarray(Consent_Policy)The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
policyRulestringA referece to the specific computable policy.
securityLabelarray(Coding)A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.
purposearray(Coding)The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.
dataPeriodPeriodClinical or Operational Relevant period of time that bounds the data controlled by this consent.
dataarray(Consent_Data)The resources controlled by this consent, if specific resources are referenced.
exceptarray(Consent_Except)An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

Response

Update Consent

put
/organizations/{organizationId}/fhir/3/Consent/{resourceId}

A record of a healthcare consumer’s policy choices, which permits or denies identified recipient(s) or recipient role(s) to perform one or more actions within a given policy context, for specific purposes and periods of time.

Request

Headers

content-type*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringConsentThis is a Consent resource
identifierIdentifierUnique identifier for this copy of the Consent Statement.
statusstringdraft|proposed|active|rejected|inactive|entered-in-errorIndicates the current state of this consent.
categoryarray(CodeableConcept)A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements.
patient*ReferenceThe patient/healthcare consumer to whom this consent applies.
periodPeriodRelevant time or time-period when this Consent is applicable.
dateTimestringWhen this Consent was issued / created / indexed.
consentingPartyarray(Reference)Either the Grantor, which is the entity responsible for granting the rights listed in a Consent Directive or the Grantee, which is the entity responsible for complying with the Consent Directive, including any obligations or limitations on authorizations and enforcement of prohibitions.
actorarray(Consent_Actor)Who or what is controlled by this consent. Use group to identify a set of actors by some property they share (e.g. 'admitting officers').
actionarray(CodeableConcept)Actions controlled by this consent.
organizationarray(Reference)The organization that manages the consent, and the framework within which it is executed.
sourceAttachmentAttachmentThe 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.
sourceIdentifierIdentifierThe 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.
sourceReferenceReferenceThe 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.
policyarray(Consent_Policy)The references to the policies that are included in this consent scope. Policies may be organizational, but are often defined jurisdictionally, or in law.
policyRulestringA referece to the specific computable policy.
securityLabelarray(Coding)A set of security labels that define which resources are controlled by this consent. If more than one label is specified, all resources must have all the specified labels.
purposearray(Coding)The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent.
dataPeriodPeriodClinical or Operational Relevant period of time that bounds the data controlled by this consent.
dataarray(Consent_Data)The resources controlled by this consent, if specific resources are referenced.
exceptarray(Consent_Except)An exception to the base policy of this consent. An exception can be an addition or removal of access permissions.

Response