Skip to main content

clinik.consents

Consents represent patient agreements to privacy policies, treatment plans, research participation, and other healthcare directives.

sign

const { data, meta } = await clinik.consents.sign(request: ConsentSignRequest): Promise<ApiResponse<Consent>>
FieldTypeRequiredDescription
patientIdstringYesPatient reference
statusstringNodraft, proposed, active, rejected, inactive
scopestringYespatient-privacy, research, treatment, adr
categorystring | string[]YesConsent category (e.g. “hipaa-notice”)
dateTimestringNoWhen consent was given
performerIdstringNoWho is agreeing (practitioner, patient)
organizationIdstringNoCustodian organization
policyUristringNoPolicy URI (shorthand for single policy)
policiesArray<{ authority?, uri? }>NoMultiple policies with authority
policyRulestringNoRegulation that this consents to
sourceAttachmentobjectNoSource document (attachment)
sourceReferenceIdstringNoSource document reference ID
verificationArray<{ verified, verifiedWith?, verificationDate? }>NoVerification details (multiple)
provisionConsentProvisionInputNoProvision rules with nested exceptions

Provision Structure

provision: {
  type: 'permit' | 'deny',
  period: { start?, end? },
  actor: [{ role: string, reference: string }],
  action: [{ system?, code, display? }],
  securityLabel: [{ system?, code, display? }],
  purpose: [{ system?, code, display? }],
  class: [{ system?, code, display? }],
  code: [{ system?, code, display? }],
  dataPeriod: { start?, end? },
  data: [{ meaning: 'instance' | 'related' | 'dependents' | 'authoredby', reference: string }],
  provision: [/* nested exception rules */],
}
Same pattern as other resources. Search supports patientId, status, dateFrom, dateTo filters.
ScopeDescription
patient-privacyPrivacy and data sharing (HIPAA notices)
researchResearch participation
treatmentTreatment consent
adrAdvance directive