consents
Create Consent
A record of a healthcare consumer’s 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+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a Consent resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Unique identifier for this copy of the Consent Statement. | |
status | draft|proposed|active|rejected|inactive|entered-in-error | Indicates the current state of this consent. | |
scope* | CodeableConcept | A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible. | |
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. | |
dateTime | dateTime | When this Consent was issued / created / indexed. | |
performer | 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. | |
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. | |
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 | CodeableConcept | A reference to the specific base computable regulation or policy. | |
verification | array(Consent_Verification) | Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person. | |
provision | Consent_Provision | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. |
Response
Patch Consent
A record of a healthcare consumer’s 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* | This is a Consent resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Unique identifier for this copy of the Consent Statement. | |
status | draft|proposed|active|rejected|inactive|entered-in-error | Indicates the current state of this consent. | |
scope* | CodeableConcept | A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible. | |
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. | |
dateTime | dateTime | When this Consent was issued / created / indexed. | |
performer | 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. | |
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. | |
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 | CodeableConcept | A reference to the specific base computable regulation or policy. | |
verification | array(Consent_Verification) | Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person. | |
provision | Consent_Provision | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. |
Response
Read Consent
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
Read History Consent
Request
Headers
content-type* | string | application/json|application/json+fhir | 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
Read Version Consent
Request
Headers
content-type* | string | application/json|application/json+fhir | 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
Remove Consent
Request
Headers
content-type* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug | |
resourceId* |
Response
Search Get Consent
Request
Headers
content-type* | string | application/json|application/json+fhir | 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 | |||
identifier | string | ||
organization | string | ||
patient | string | ||
period | |||
purpose | string | ||
scope | string | ||
securitylabel | string | ||
source-reference | string | ||
status | string |
Params
organizationId* | string|string | id|slug |
Response
Search History Consent
Request
Headers
content-type* | string | application/json|application/json+fhir | 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
Search Post Consent
A record of a healthcare consumer’s 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 | |||
identifier | string | ||
organization | string | ||
patient | string | ||
period | |||
purpose | string | ||
scope | string | ||
securitylabel | string | ||
source-reference | string | ||
status | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a Consent resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Unique identifier for this copy of the Consent Statement. | |
status | draft|proposed|active|rejected|inactive|entered-in-error | Indicates the current state of this consent. | |
scope* | CodeableConcept | A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible. | |
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. | |
dateTime | dateTime | When this Consent was issued / created / indexed. | |
performer | 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. | |
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. | |
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 | CodeableConcept | A reference to the specific base computable regulation or policy. | |
verification | array(Consent_Verification) | Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person. | |
provision | Consent_Provision | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. |
Response
Update Consent
A record of a healthcare consumer’s 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+fhir | 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* | This is a Consent resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |
implicitRules | uri | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | |
language | code | The base language in which the resource is written. | |
text | Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | |
contained | array(ResourceList) | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | |
extension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | |
modifierExtension | array(Extension) | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | |
identifier | array(Identifier) | Unique identifier for this copy of the Consent Statement. | |
status | draft|proposed|active|rejected|inactive|entered-in-error | Indicates the current state of this consent. | |
scope* | CodeableConcept | A selector of the type of consent being presented: ADR, Privacy, Treatment, Research. This list is now extensible. | |
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. | |
dateTime | dateTime | When this Consent was issued / created / indexed. | |
performer | 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. | |
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. | |
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 | CodeableConcept | A reference to the specific base computable regulation or policy. | |
verification | array(Consent_Verification) | Whether a treatment instruction (e.g. artificial respiration yes or no) was verified with the patient, his/her family or another authorized person. | |
provision | Consent_Provision | An exception to the base policy of this consent. An exception can be an addition or removal of access permissions. |