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* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Consent | This is a Consent resource |
| identifier | Identifier | Unique identifier for this copy of the Consent Statement. | |
| status | string | draft|proposed|active|rejected|inactive|entered-in-error | Indicates the current state of this consent. |
| category | array(CodeableConcept) | A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. | |
| patient* | Reference | The patient/healthcare consumer to whom this consent applies. | |
| period | Period | Relevant time or time-period when this Consent is applicable. | |
| dateTime | string | When this Consent was issued / created / indexed. | |
| consentingParty | array(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. | |
| actor | array(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'). | |
| action | array(CodeableConcept) | Actions controlled by this consent. | |
| organization | array(Reference) | The organization that manages the consent, and the framework within which it is executed. | |
| sourceAttachment | Attachment | 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. | |
| sourceIdentifier | Identifier | 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. | |
| sourceReference | Reference | 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. | |
| policy | array(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. | |
| policyRule | string | A referece to the specific computable policy. | |
| securityLabel | array(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. | |
| purpose | array(Coding) | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent. | |
| dataPeriod | Period | Clinical or Operational Relevant period of time that bounds the data controlled by this consent. | |
| data | array(Consent_Data) | The resources controlled by this consent, if specific resources are referenced. | |
| except | array(Consent_Except) | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. |
Response
keyboard_arrow_down
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* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | Consent | This is a Consent resource |
| identifier | Identifier | Unique identifier for this copy of the Consent Statement. | |
| status | string | draft|proposed|active|rejected|inactive|entered-in-error | Indicates the current state of this consent. |
| category | array(CodeableConcept) | A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. | |
| patient* | Reference | The patient/healthcare consumer to whom this consent applies. | |
| period | Period | Relevant time or time-period when this Consent is applicable. | |
| dateTime | string | When this Consent was issued / created / indexed. | |
| consentingParty | array(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. | |
| actor | array(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'). | |
| action | array(CodeableConcept) | Actions controlled by this consent. | |
| organization | array(Reference) | The organization that manages the consent, and the framework within which it is executed. | |
| sourceAttachment | Attachment | 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. | |
| sourceIdentifier | Identifier | 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. | |
| sourceReference | Reference | 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. | |
| policy | array(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. | |
| policyRule | string | A referece to the specific computable policy. | |
| securityLabel | array(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. | |
| purpose | array(Coding) | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent. | |
| dataPeriod | Period | Clinical or Operational Relevant period of time that bounds the data controlled by this consent. | |
| data | array(Consent_Data) | The resources controlled by this consent, if specific resources are referenced. | |
| except | array(Consent_Except) | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. |
Response
keyboard_arrow_down
Read Consent
get
/organizations/{organizationId}/fhir/3/Consent/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Consent
get
/organizations/{organizationId}/fhir/3/Consent/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Consent
get
/organizations/{organizationId}/fhir/3/Consent/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Consent
delete
/organizations/{organizationId}/fhir/3/Consent/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Consent
get
/organizations/{organizationId}/fhir/3/Consent
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| action | string | ||
| actor | string | ||
| category | string | ||
| consentor | string | ||
| data | string | ||
| date | string | ||
| identifier | string | ||
| organization | string | ||
| patient | string | ||
| period | string | ||
| purpose | string | ||
| securitylabel | string | ||
| source | string | ||
| status | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Consent
get
/organizations/{organizationId}/fhir/3/Consent/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
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* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| action | string | ||
| actor | string | ||
| category | string | ||
| consentor | string | ||
| data | string | ||
| date | string | ||
| identifier | string | ||
| organization | string | ||
| patient | string | ||
| period | string | ||
| purpose | string | ||
| securitylabel | string | ||
| source | string | ||
| status | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | Consent | This is a Consent resource |
| identifier | Identifier | Unique identifier for this copy of the Consent Statement. | |
| status | string | draft|proposed|active|rejected|inactive|entered-in-error | Indicates the current state of this consent. |
| category | array(CodeableConcept) | A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. | |
| patient* | Reference | The patient/healthcare consumer to whom this consent applies. | |
| period | Period | Relevant time or time-period when this Consent is applicable. | |
| dateTime | string | When this Consent was issued / created / indexed. | |
| consentingParty | array(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. | |
| actor | array(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'). | |
| action | array(CodeableConcept) | Actions controlled by this consent. | |
| organization | array(Reference) | The organization that manages the consent, and the framework within which it is executed. | |
| sourceAttachment | Attachment | 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. | |
| sourceIdentifier | Identifier | 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. | |
| sourceReference | Reference | 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. | |
| policy | array(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. | |
| policyRule | string | A referece to the specific computable policy. | |
| securityLabel | array(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. | |
| purpose | array(Coding) | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent. | |
| dataPeriod | Period | Clinical or Operational Relevant period of time that bounds the data controlled by this consent. | |
| data | array(Consent_Data) | The resources controlled by this consent, if specific resources are referenced. | |
| except | array(Consent_Except) | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. |
Response
keyboard_arrow_down
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* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | Consent | This is a Consent resource |
| identifier | Identifier | Unique identifier for this copy of the Consent Statement. | |
| status | string | draft|proposed|active|rejected|inactive|entered-in-error | Indicates the current state of this consent. |
| category | array(CodeableConcept) | A classification of the type of consents found in the statement. This element supports indexing and retrieval of consent statements. | |
| patient* | Reference | The patient/healthcare consumer to whom this consent applies. | |
| period | Period | Relevant time or time-period when this Consent is applicable. | |
| dateTime | string | When this Consent was issued / created / indexed. | |
| consentingParty | array(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. | |
| actor | array(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'). | |
| action | array(CodeableConcept) | Actions controlled by this consent. | |
| organization | array(Reference) | The organization that manages the consent, and the framework within which it is executed. | |
| sourceAttachment | Attachment | 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. | |
| sourceIdentifier | Identifier | 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. | |
| sourceReference | Reference | 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. | |
| policy | array(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. | |
| policyRule | string | A referece to the specific computable policy. | |
| securityLabel | array(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. | |
| purpose | array(Coding) | The context of the activities a user is taking - why the user is accessing the data - that are controlled by this consent. | |
| dataPeriod | Period | Clinical or Operational Relevant period of time that bounds the data controlled by this consent. | |
| data | array(Consent_Data) | The resources controlled by this consent, if specific resources are referenced. | |
| except | array(Consent_Except) | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. |
Response
keyboard_arrow_down