Uzbekistan Digital Health Platform
0.11.1 - ci-build Uzbekistan flag

Uzbekistan Digital Health Platform, published by Ministry of Health of the Republic of Uzbekistan. This guide is not an authorized publication; it is the continuous build for version 0.11.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/uzinfocom-org/digital-health-ig/ and changes regularly. See the Directory of published versions

Resource Profile: UZ Core Consent ( Experimental )

Official URL: https://dhp.uz/fhir/core/StructureDefinition/uz-core-consent Version: 0.11.1
Active as of 2025-06-02 Computable Name: UZCoreConsent

Uzbekistan Core Consent profile, used to manage patient consent for data sharing and processing

UZ Core Consent records the patient's own decision about whether their health data may be shared on the Digital Health Platform. Uzbekistan operates an opt-out model: when no Consent resource exists for a patient, sharing is permitted by default, and a patient opts out by recording a Consent that denies it. The model is intentionally binary - a single provision that either permits or denies - and the patient sets it themselves in the patient portal. The platform enforces it: when a consent denies access, a data request is refused with HTTP 403. Two exceptions exist - a lawful-access path for treating clinicians and other legally authorized parties, and an emergency break-glass path (recorded in AuditEvent with an emergency purpose-of-use). A Consent is anchored to its Patient.

Mandatory and Must Support data elements

The elements below must always be present (mandatory) or must be supported when the data is available (Must Support) - not all are required, but your system must populate each Must Support element when it has the data and process it on receipt. This is the human-readable summary; the formal views below give the exact cardinalities, types, and terminology bindings.

This profile adds no mandatory cardinality of its own. The only required element is the one inherited from the base resource: a status (the state of the consent record itself, bound to the DHP consent-state value set).

  • a subject - the patient the consent belongs to;
  • a grantor - the party granting the decision (the patient);
  • a period - the start and end of the time the consent applies;
  • a regulatory basis identifying the law or policy behind it (required binding);
  • a decision - permit or deny (required binding);
  • a source - either a sourceAttachment (with its url and creation date) or a sourceReference carrying the underlying consent document;
  • a provision narrowing the decision, with its action and purpose (both required bindings).

The decision is binary by design: one decision of permit or deny. The platform reads it to allow or refuse each data request.

Building the JSON, step by step

A Consent is mostly system-generated when the patient sets it in the portal, so there is little to build by hand. The example below is the full record - copy it and adapt it; every value shown validates against this profile. The complete instance is the example Consent.

status is the only strictly mandatory element, but a Consent is only meaningful when it names whose data it covers (subject), what it decides (decision - the scalar code permit or deny), and what that decision applies to (a provision). Because the absence of a Consent already permits sharing, the record you send is normally an opt-out: a deny whose provision.action says what is being withheld - here, disclosure. Every UZ Core resource must also name the profile it claims to conform to in meta.profile:

{
  "resourceType": "Consent",
  "meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-consent"] },
  "status": "active",
  "subject": { "reference": "Patient/example-patient" },
  "decision": "deny",
  "provision": [
    {
      "action": [
        { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/consentaction", "code": "disclose" }] }
      ]
    }
  ]
}

status and decision each use a required binding - the value must come from the bound value set (the Snapshot view below lists each one). provision.action is a CodeableConcept, so its code sits in a coding array; subject is a plain Reference, so its target sits directly under reference.

A fuller record - shown here granting access, as a patient would when re-opting in or scoping consent to a specific purpose and period - also records who granted the decision (grantor, the patient), how long it applies (period), the law it rests on (regulatoryBasis), and a provision narrowing the decision to a specific action and purpose. grantor is a list of References, and regulatoryBasis, provision.action and provision.purpose are coded - each value comes from a bound value set:

{
  "resourceType": "Consent",
  "meta": { "profile": ["https://dhp.uz/fhir/core/StructureDefinition/uz-core-consent"] },
  "status": "active",
  "subject": { "reference": "Patient/example-patient" },
  "grantor": [
    { "reference": "Patient/example-patient" }
  ],
  "period": {
    "start": "2025-02-15T14:02:52+05:00",
    "end": "2026-02-15T14:02:52+05:00"
  },
  "regulatoryBasis": [
    {
      "coding": [
        { "system": "https://terminology.dhp.uz/fhir/core/CodeSystem/consent-policy-cs", "code": "uz-LRU-547" }
      ]
    }
  ],
  "decision": "permit",
  "provision": [
    {
      "action": [
        { "coding": [{ "system": "http://terminology.hl7.org/CodeSystem/consentaction", "code": "disclose" }] }
      ],
      "purpose": [
        { "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason", "code": "RECORDMGT" }
      ],
      "period": {
        "start": "2025-02-15T14:02:52+05:00",
        "end": "2026-02-15T14:02:52+05:00"
      }
    }
  ]
}

Note that provision.purpose is a Coding directly (not wrapped in a coding array), while regulatoryBasis and provision.action are CodeableConcept types that hold a coding array. This record grants access; an opt-out is the same shape with decision set to deny, after which the platform refuses each data request with HTTP 403. See Missing & suppressed data and Terminology for the coded-value rules.

For example API calls and a sample payload, see the Quick Start at the bottom of this page.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent 0..* Consent(5.0.0) A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.contained 0..* Resource Contained, inline Resources
Consent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
Consent.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
Binding: ConsentStateCodesVS (0.11.1) (required)
Consent.subject This element must be supported. This element is included in summaries. 0..1 Reference(Patient | Practitioner | Group) Who the consent applies to
Consent.period This element must be supported. This element is included in summaries. 0..1 Period Effective period for this Consent
Consent.period.start This element must be supported. This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Consent.period.end This element must be supported. This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Consent.grantor This element must be supported. This element is included in summaries. 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is granting rights according to the policy and rules
Consent.sourceAttachment This element must be supported. 0..* Attachment Source from which this consent is taken
Consent.sourceAttachment.url This element must be supported. This element is included in summaries. 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
Consent.sourceAttachment.creation This element must be supported. This element is included in summaries. 0..1 dateTime Date attachment was first created
Consent.sourceReference This element must be supported. 0..* Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Source from which this consent is taken
Consent.Slices for regulatoryBasis This element must be supported. 0..* CodeableConcept Regulations establishing base Consent
Slice: Unordered, Open by value:$this
Binding: ConsentPolicyVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for regulatoryBasis.regulatoryBasis:dhpRegulatoryBasis This element must be supported. 0..* CodeableConcept Regulatory basis from the national value set
Binding: ConsentPolicyVS (0.11.1) (required)
Consent.decision This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code deny | permit
Binding: ConsentProvisionTypeVS (0.11.1) (required)
Consent.provision This element must be supported. This element is included in summaries. 0..* BackboneElement Constraints to the base Consent.policyRule/Consent.policy
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Consent.provision.Slices for action This element is included in summaries. 0..* CodeableConcept Actions controlled by this provision
Slice: Unordered, Open by value:$this
Binding: ConsentActionVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for action.action:dhpAction This element is included in summaries. 0..* CodeableConcept Action from the national value set
Binding: ConsentActionVS (0.11.1) (required)
Consent.provision.purpose This element is included in summaries. 0..* Coding Context of activities covered by this provision
Binding: ConsentPurposeOfUseVS (0.11.1) (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required Consent State Codes 📍0.11.1 This IG
Consent.regulatoryBasis Base preferred Consent policies 📍0.11.1 This IG
Consent.regulatoryBasis:dhpRegulatoryBasis Base required Consent policies 📍0.11.1 This IG
Consent.decision Base required Consent provision type 📍0.11.1 This IG
Consent.provision.action Base preferred Possible consent actions 📍0.11.1 This IG
Consent.provision.action:dhpAction Base required Possible consent actions 📍0.11.1 This IG
Consent.provision.purpose Base extensible Consent purpose of use 📍0.11.1 This IG

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent 0..* Consent(5.0.0) A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Consent.status This element must be supported. 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
Binding: ConsentStateCodesVS (0.11.1) (required)
Consent.subject This element must be supported. 0..1 Reference(Patient | Practitioner | Group) Who the consent applies to
Consent.period This element must be supported. 0..1 Period Effective period for this Consent
Consent.period.start This element must be supported. 0..1 dateTime Starting time with inclusive boundary
Consent.period.end This element must be supported. 0..1 dateTime End time with inclusive boundary, if not ongoing
Consent.sourceAttachment This element must be supported. 0..* Attachment Source from which this consent is taken
Consent.sourceAttachment.url This element must be supported. 0..1 url Uri where the data can be found
Consent.sourceAttachment.creation This element must be supported. 0..1 dateTime Date attachment was first created
Consent.sourceReference This element must be supported. 0..* Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Source from which this consent is taken
Consent.Slices for regulatoryBasis This element must be supported. 0..* CodeableConcept Regulations establishing base Consent
Slice: Unordered, Open by value:$this
Binding: ConsentPolicyVS (0.11.1) (preferred)
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for regulatoryBasis.regulatoryBasis:dhpRegulatoryBasis This element must be supported. 0..* CodeableConcept Regulatory basis from the national value set
Binding: ConsentPolicyVS (0.11.1) (required)
Consent.decision This element must be supported. 0..1 code deny | permit
Binding: ConsentProvisionTypeVS (0.11.1) (required)
Consent.provision This element must be supported. 0..* BackboneElement Constraints to the base Consent.policyRule/Consent.policy
Consent.provision.Slices for action 0..* CodeableConcept Actions controlled by this provision
Slice: Unordered, Open by value:$this
Binding: ConsentActionVS (0.11.1) (preferred)
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for action.action:dhpAction 0..* CodeableConcept Action from the national value set
Binding: ConsentActionVS (0.11.1) (required)
Consent.provision.purpose 0..* Coding Context of activities covered by this provision
Binding: ConsentPurposeOfUseVS (0.11.1) (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Consent.status Base required Consent State Codes 📍0.11.1 This IG
Consent.regulatoryBasis Base preferred Consent policies 📍0.11.1 This IG
Consent.regulatoryBasis:dhpRegulatoryBasis Base required Consent policies 📍0.11.1 This IG
Consent.decision Base required Consent provision type 📍0.11.1 This IG
Consent.provision.action Base preferred Possible consent actions 📍0.11.1 This IG
Consent.provision.action:dhpAction Base required Possible consent actions 📍0.11.1 This IG
Consent.provision.purpose Base extensible Consent purpose of use 📍0.11.1 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent 0..* Consent(5.0.0) A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Consent.id This element is included in summaries. 0..1 id Logical id of this artifact
Consent.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Consent.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Consent.contained 0..* Resource Contained, inline Resources
Consent.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Consent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
Consent.identifier This element is included in summaries. 0..* Identifier Identifier for this record (external references)
Consent.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
Binding: ConsentStateCodesVS (0.11.1) (required)
Consent.category This element is included in summaries. 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (example): A classification of the type of consents found in a consent statement.
Consent.subject This element must be supported. This element is included in summaries. 0..1 Reference(Patient | Practitioner | Group) Who the consent applies to
Consent.date This element is included in summaries. 0..1 date Fully executed date of the consent
Consent.period This element must be supported. This element is included in summaries. 0..1 Period Effective period for this Consent
Consent.period.id 0..1 id Unique id for inter-element referencing
Consent.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Consent.period.start This element must be supported. This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Consent.period.end This element must be supported. This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Consent.grantor This element must be supported. This element is included in summaries. 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is granting rights according to the policy and rules
Consent.grantee This element is included in summaries. 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
Consent.manager 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent workflow management
Consent.controller 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent Enforcer
Consent.sourceAttachment This element must be supported. 0..* Attachment Source from which this consent is taken
Consent.sourceAttachment.id 0..1 id Unique id for inter-element referencing
Consent.sourceAttachment.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Consent.sourceAttachment.contentType This element is included in summaries. C 0..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
Consent.sourceAttachment.language This element is included in summaries. 0..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.
Additional BindingsPurpose
CommonLanguages Starter

Example General: en-AU
Consent.sourceAttachment.data C 0..1 base64Binary Data inline, base64ed
Consent.sourceAttachment.url This element must be supported. This element is included in summaries. 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
Consent.sourceAttachment.size This element is included in summaries. 0..1 integer64 Number of bytes of content (if url provided)
Consent.sourceAttachment.hash This element is included in summaries. 0..1 base64Binary Hash of the data (sha-1, base64ed)
Consent.sourceAttachment.title This element is included in summaries. 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
Consent.sourceAttachment.creation This element must be supported. This element is included in summaries. 0..1 dateTime Date attachment was first created
Consent.sourceAttachment.height 0..1 positiveInt Height of the image in pixels (photo/video)
Consent.sourceAttachment.width 0..1 positiveInt Width of the image in pixels (photo/video)
Consent.sourceAttachment.frames 0..1 positiveInt Number of frames if > 1 (photo)
Consent.sourceAttachment.duration 0..1 decimal Length in seconds (audio / video)
Consent.sourceAttachment.pages 0..1 positiveInt Number of printed pages
Consent.sourceReference This element must be supported. 0..* Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Source from which this consent is taken
Consent.Slices for regulatoryBasis This element must be supported. 0..* CodeableConcept Regulations establishing base Consent
Slice: Unordered, Open by value:$this
Binding: ConsentPolicyVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for regulatoryBasis.regulatoryBasis:dhpRegulatoryBasis This element must be supported. 0..* CodeableConcept Regulatory basis from the national value set
Binding: ConsentPolicyVS (0.11.1) (required)
Consent.policyBasis 0..1 BackboneElement Computable version of the backing policy
Consent.policyBasis.id 0..1 string Unique id for inter-element referencing
Consent.policyBasis.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Consent.policyBasis.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Consent.policyBasis.reference 0..1 Reference(Resource) Reference backing policy resource
Consent.policyBasis.url 0..1 url URL to a computable backing policy
Consent.policyText 0..* Reference(DocumentReference) Human Readable Policy
Consent.verification This element is included in summaries. 0..* BackboneElement Consent Verified by patient or family
Consent.verification.id 0..1 string Unique id for inter-element referencing
Consent.verification.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Consent.verification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Consent.verification.verified This element is included in summaries. 1..1 boolean Has been verified
Consent.verification.verificationType 0..1 CodeableConcept Business case of verification
Binding: ConsentVerificationCodes (example): Types of Verification/Validation.
Consent.verification.verifiedBy 0..1 Reference(Organization | Practitioner | PractitionerRole) Person conducting verification
Consent.verification.verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified
Consent.verification.verificationDate 0..* dateTime When consent verified
Consent.decision This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code deny | permit
Binding: ConsentProvisionTypeVS (0.11.1) (required)
Consent.provision This element must be supported. This element is included in summaries. 0..* BackboneElement Constraints to the base Consent.policyRule/Consent.policy
Consent.provision.id 0..1 string Unique id for inter-element referencing
Consent.provision.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Consent.provision.period This element is included in summaries. 0..1 Period Timeframe for this provision
Consent.provision.actor 0..* BackboneElement Who|what controlled by this provision (or group, by role)
Consent.provision.actor.id 0..1 string Unique id for inter-element referencing
Consent.provision.actor.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Consent.provision.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Consent.provision.actor.role 0..1 CodeableConcept How the actor is involved
Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations.
Consent.provision.actor.reference 0..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Resource for the actor (or group, by role)
Consent.provision.Slices for action This element is included in summaries. 0..* CodeableConcept Actions controlled by this provision
Slice: Unordered, Open by value:$this
Binding: ConsentActionVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for action.action:dhpAction This element is included in summaries. 0..* CodeableConcept Action from the national value set
Binding: ConsentActionVS (0.11.1) (required)
Consent.provision.securityLabel This element is included in summaries. 0..* Coding Security Labels that define affected resources
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
Consent.provision.purpose This element is included in summaries. 0..* Coding Context of activities covered by this provision
Binding: ConsentPurposeOfUseVS (0.11.1) (extensible)
Consent.provision.documentType This element is included in summaries. 0..* Coding e.g. Resource Type, Profile, CDA, etc
Binding: ConsentContentClass (preferred): The document type a consent provision covers.
Consent.provision.resourceType This element is included in summaries. 0..* Coding e.g. Resource Type, Profile, etc
Binding: ResourceType (extensible): The resource types a consent provision covers.
Consent.provision.code This element is included in summaries. 0..* CodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
Consent.provision.dataPeriod This element is included in summaries. 0..1 Period Timeframe for data controlled by this provision
Consent.provision.data This element is included in summaries. 0..* BackboneElement Data controlled by this provision
Consent.provision.data.id 0..1 string Unique id for inter-element referencing
Consent.provision.data.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Consent.provision.data.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Consent.provision.data.meaning This element is included in summaries. 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Consent.provision.data.reference This element is included in summaries. 1..1 Reference(Resource) The actual data reference
Consent.provision.expression 0..1 Expression A computable expression of the consent
Consent.provision.provision 0..* See provision (Consent) Nested Exception Provisions

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base required All Languages 📍5.0.0 FHIR Std.
Consent.status Base required Consent State Codes 📍0.11.1 This IG
Consent.category Base example Consent Category Codes 📍5.0.0 FHIR Std.
Consent.sourceAttachment.​contentType Base required Mime Types 📍5.0.0 FHIR Std.
Consent.sourceAttachment.​language Base required All Languages 📍5.0.0 FHIR Std.
Consent.regulatoryBasis Base preferred Consent policies 📍0.11.1 This IG
Consent.regulatoryBasis:dhpRegulatoryBasis Base required Consent policies 📍0.11.1 This IG
Consent.verification.​verificationType Base example Consent Vefication Codes 📍5.0.0 FHIR Std.
Consent.decision Base required Consent provision type 📍0.11.1 This IG
Consent.provision.actor.​role Base extensible Participation Role Type 📍5.0.0 FHIR Std.
Consent.provision.action Base preferred Possible consent actions 📍0.11.1 This IG
Consent.provision.action:dhpAction Base required Possible consent actions 📍0.11.1 This IG
Consent.provision.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
Consent.provision.purpose Base extensible Consent purpose of use 📍0.11.1 This IG
Consent.provision.documentType Base preferred Consent Content Class 📍5.0.0 FHIR Std.
Consent.provision.resourceType Base extensible Resource Types 📍5.0.0 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍5.0.0 FHIR Std.
Consent.provision.data.​meaning Base required Consent Data Meaning 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Consent

Summary

Must-Support: 14 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Consent.regulatoryBasis
  • The element 1 is sliced based on the value of Consent.provision.action

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent 0..* Consent(5.0.0) A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.contained 0..* Resource Contained, inline Resources
Consent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
Consent.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
Binding: ConsentStateCodesVS (0.11.1) (required)
Consent.subject This element must be supported. This element is included in summaries. 0..1 Reference(Patient | Practitioner | Group) Who the consent applies to
Consent.period This element must be supported. This element is included in summaries. 0..1 Period Effective period for this Consent
Consent.period.start This element must be supported. This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Consent.period.end This element must be supported. This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Consent.grantor This element must be supported. This element is included in summaries. 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is granting rights according to the policy and rules
Consent.sourceAttachment This element must be supported. 0..* Attachment Source from which this consent is taken
Consent.sourceAttachment.url This element must be supported. This element is included in summaries. 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
Consent.sourceAttachment.creation This element must be supported. This element is included in summaries. 0..1 dateTime Date attachment was first created
Consent.sourceReference This element must be supported. 0..* Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Source from which this consent is taken
Consent.Slices for regulatoryBasis This element must be supported. 0..* CodeableConcept Regulations establishing base Consent
Slice: Unordered, Open by value:$this
Binding: ConsentPolicyVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for regulatoryBasis.regulatoryBasis:dhpRegulatoryBasis This element must be supported. 0..* CodeableConcept Regulatory basis from the national value set
Binding: ConsentPolicyVS (0.11.1) (required)
Consent.decision This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code deny | permit
Binding: ConsentProvisionTypeVS (0.11.1) (required)
Consent.provision This element must be supported. This element is included in summaries. 0..* BackboneElement Constraints to the base Consent.policyRule/Consent.policy
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Consent.provision.Slices for action This element is included in summaries. 0..* CodeableConcept Actions controlled by this provision
Slice: Unordered, Open by value:$this
Binding: ConsentActionVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for action.action:dhpAction This element is included in summaries. 0..* CodeableConcept Action from the national value set
Binding: ConsentActionVS (0.11.1) (required)
Consent.provision.purpose This element is included in summaries. 0..* Coding Context of activities covered by this provision
Binding: ConsentPurposeOfUseVS (0.11.1) (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required Consent State Codes 📍0.11.1 This IG
Consent.regulatoryBasis Base preferred Consent policies 📍0.11.1 This IG
Consent.regulatoryBasis:dhpRegulatoryBasis Base required Consent policies 📍0.11.1 This IG
Consent.decision Base required Consent provision type 📍0.11.1 This IG
Consent.provision.action Base preferred Possible consent actions 📍0.11.1 This IG
Consent.provision.action:dhpAction Base required Possible consent actions 📍0.11.1 This IG
Consent.provision.purpose Base extensible Consent purpose of use 📍0.11.1 This IG

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent 0..* Consent(5.0.0) A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Consent.status This element must be supported. 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
Binding: ConsentStateCodesVS (0.11.1) (required)
Consent.subject This element must be supported. 0..1 Reference(Patient | Practitioner | Group) Who the consent applies to
Consent.period This element must be supported. 0..1 Period Effective period for this Consent
Consent.period.start This element must be supported. 0..1 dateTime Starting time with inclusive boundary
Consent.period.end This element must be supported. 0..1 dateTime End time with inclusive boundary, if not ongoing
Consent.grantor This element must be supported. 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is granting rights according to the policy and rules
Consent.sourceAttachment This element must be supported. 0..* Attachment Source from which this consent is taken
Consent.sourceAttachment.url This element must be supported. 0..1 url Uri where the data can be found
Consent.sourceAttachment.creation This element must be supported. 0..1 dateTime Date attachment was first created
Consent.sourceReference This element must be supported. 0..* Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Source from which this consent is taken
Consent.Slices for regulatoryBasis This element must be supported. 0..* CodeableConcept Regulations establishing base Consent
Slice: Unordered, Open by value:$this
Binding: ConsentPolicyVS (0.11.1) (preferred)
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for regulatoryBasis.regulatoryBasis:dhpRegulatoryBasis This element must be supported. 0..* CodeableConcept Regulatory basis from the national value set
Binding: ConsentPolicyVS (0.11.1) (required)
Consent.decision This element must be supported. 0..1 code deny | permit
Binding: ConsentProvisionTypeVS (0.11.1) (required)
Consent.provision This element must be supported. 0..* BackboneElement Constraints to the base Consent.policyRule/Consent.policy
Consent.provision.Slices for action 0..* CodeableConcept Actions controlled by this provision
Slice: Unordered, Open by value:$this
Binding: ConsentActionVS (0.11.1) (preferred)
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for action.action:dhpAction 0..* CodeableConcept Action from the national value set
Binding: ConsentActionVS (0.11.1) (required)
Consent.provision.purpose 0..* Coding Context of activities covered by this provision
Binding: ConsentPurposeOfUseVS (0.11.1) (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Consent.status Base required Consent State Codes 📍0.11.1 This IG
Consent.regulatoryBasis Base preferred Consent policies 📍0.11.1 This IG
Consent.regulatoryBasis:dhpRegulatoryBasis Base required Consent policies 📍0.11.1 This IG
Consent.decision Base required Consent provision type 📍0.11.1 This IG
Consent.provision.action Base preferred Possible consent actions 📍0.11.1 This IG
Consent.provision.action:dhpAction Base required Possible consent actions 📍0.11.1 This IG
Consent.provision.purpose Base extensible Consent purpose of use 📍0.11.1 This IG

Snapshot ViewView

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Consent 0..* Consent(5.0.0) A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Consent.id This element is included in summaries. 0..1 id Logical id of this artifact
Consent.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
Consent.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Consent.contained 0..* Resource Contained, inline Resources
Consent.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Consent.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
Consent.identifier This element is included in summaries. 0..* Identifier Identifier for this record (external references)
Consent.status This element is a modifier element. This element must be supported. This element is included in summaries. 1..1 code draft | active | inactive | not-done | entered-in-error | unknown
Binding: ConsentStateCodesVS (0.11.1) (required)
Consent.category This element is included in summaries. 0..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (example): A classification of the type of consents found in a consent statement.
Consent.subject This element must be supported. This element is included in summaries. 0..1 Reference(Patient | Practitioner | Group) Who the consent applies to
Consent.date This element is included in summaries. 0..1 date Fully executed date of the consent
Consent.period This element must be supported. This element is included in summaries. 0..1 Period Effective period for this Consent
Consent.period.id 0..1 id Unique id for inter-element referencing
Consent.period.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Consent.period.start This element must be supported. This element is included in summaries. C 0..1 dateTime Starting time with inclusive boundary
Consent.period.end This element must be supported. This element is included in summaries. C 0..1 dateTime End time with inclusive boundary, if not ongoing
Consent.grantor This element must be supported. This element is included in summaries. 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is granting rights according to the policy and rules
Consent.grantee This element is included in summaries. 0..* Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
Consent.manager 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent workflow management
Consent.controller 0..* Reference(HealthcareService | Organization | Patient | Practitioner) Consent Enforcer
Consent.sourceAttachment This element must be supported. 0..* Attachment Source from which this consent is taken
Consent.sourceAttachment.id 0..1 id Unique id for inter-element referencing
Consent.sourceAttachment.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Consent.sourceAttachment.contentType This element is included in summaries. C 0..1 code Mime type of the content, with charset etc.
Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049)
Example General: text/plain; charset=UTF-8, image/png
Consent.sourceAttachment.language This element is included in summaries. 0..1 code Human language of the content (BCP-47)
Binding: AllLanguages (required): IETF language tag for a human language.
Additional BindingsPurpose
CommonLanguages Starter

Example General: en-AU
Consent.sourceAttachment.data C 0..1 base64Binary Data inline, base64ed
Consent.sourceAttachment.url This element must be supported. This element is included in summaries. 0..1 url Uri where the data can be found
Example General: http://www.acme.com/logo-small.png
Consent.sourceAttachment.size This element is included in summaries. 0..1 integer64 Number of bytes of content (if url provided)
Consent.sourceAttachment.hash This element is included in summaries. 0..1 base64Binary Hash of the data (sha-1, base64ed)
Consent.sourceAttachment.title This element is included in summaries. 0..1 string Label to display in place of the data
Example General: Official Corporate Logo
Consent.sourceAttachment.creation This element must be supported. This element is included in summaries. 0..1 dateTime Date attachment was first created
Consent.sourceAttachment.height 0..1 positiveInt Height of the image in pixels (photo/video)
Consent.sourceAttachment.width 0..1 positiveInt Width of the image in pixels (photo/video)
Consent.sourceAttachment.frames 0..1 positiveInt Number of frames if > 1 (photo)
Consent.sourceAttachment.duration 0..1 decimal Length in seconds (audio / video)
Consent.sourceAttachment.pages 0..1 positiveInt Number of printed pages
Consent.sourceReference This element must be supported. 0..* Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) Source from which this consent is taken
Consent.Slices for regulatoryBasis This element must be supported. 0..* CodeableConcept Regulations establishing base Consent
Slice: Unordered, Open by value:$this
Binding: ConsentPolicyVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for regulatoryBasis.regulatoryBasis:dhpRegulatoryBasis This element must be supported. 0..* CodeableConcept Regulatory basis from the national value set
Binding: ConsentPolicyVS (0.11.1) (required)
Consent.policyBasis 0..1 BackboneElement Computable version of the backing policy
Consent.policyBasis.id 0..1 string Unique id for inter-element referencing
Consent.policyBasis.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Consent.policyBasis.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Consent.policyBasis.reference 0..1 Reference(Resource) Reference backing policy resource
Consent.policyBasis.url 0..1 url URL to a computable backing policy
Consent.policyText 0..* Reference(DocumentReference) Human Readable Policy
Consent.verification This element is included in summaries. 0..* BackboneElement Consent Verified by patient or family
Consent.verification.id 0..1 string Unique id for inter-element referencing
Consent.verification.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Consent.verification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Consent.verification.verified This element is included in summaries. 1..1 boolean Has been verified
Consent.verification.verificationType 0..1 CodeableConcept Business case of verification
Binding: ConsentVerificationCodes (example): Types of Verification/Validation.
Consent.verification.verifiedBy 0..1 Reference(Organization | Practitioner | PractitionerRole) Person conducting verification
Consent.verification.verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified
Consent.verification.verificationDate 0..* dateTime When consent verified
Consent.decision This element is a modifier element. This element must be supported. This element is included in summaries. 0..1 code deny | permit
Binding: ConsentProvisionTypeVS (0.11.1) (required)
Consent.provision This element must be supported. This element is included in summaries. 0..* BackboneElement Constraints to the base Consent.policyRule/Consent.policy
Consent.provision.id 0..1 string Unique id for inter-element referencing
Consent.provision.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Consent.provision.period This element is included in summaries. 0..1 Period Timeframe for this provision
Consent.provision.actor 0..* BackboneElement Who|what controlled by this provision (or group, by role)
Consent.provision.actor.id 0..1 string Unique id for inter-element referencing
Consent.provision.actor.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Consent.provision.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Consent.provision.actor.role 0..1 CodeableConcept How the actor is involved
Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations.
Consent.provision.actor.reference 0..1 Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Resource for the actor (or group, by role)
Consent.provision.Slices for action This element is included in summaries. 0..* CodeableConcept Actions controlled by this provision
Slice: Unordered, Open by value:$this
Binding: ConsentActionVS (0.11.1) (preferred)

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.provision.Slices for action.action:dhpAction This element is included in summaries. 0..* CodeableConcept Action from the national value set
Binding: ConsentActionVS (0.11.1) (required)
Consent.provision.securityLabel This element is included in summaries. 0..* Coding Security Labels that define affected resources
Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
Consent.provision.purpose This element is included in summaries. 0..* Coding Context of activities covered by this provision
Binding: ConsentPurposeOfUseVS (0.11.1) (extensible)
Consent.provision.documentType This element is included in summaries. 0..* Coding e.g. Resource Type, Profile, CDA, etc
Binding: ConsentContentClass (preferred): The document type a consent provision covers.
Consent.provision.resourceType This element is included in summaries. 0..* Coding e.g. Resource Type, Profile, etc
Binding: ResourceType (extensible): The resource types a consent provision covers.
Consent.provision.code This element is included in summaries. 0..* CodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
Consent.provision.dataPeriod This element is included in summaries. 0..1 Period Timeframe for data controlled by this provision
Consent.provision.data This element is included in summaries. 0..* BackboneElement Data controlled by this provision
Consent.provision.data.id 0..1 string Unique id for inter-element referencing
Consent.provision.data.extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
Consent.provision.data.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
Consent.provision.data.meaning This element is included in summaries. 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Consent.provision.data.reference This element is included in summaries. 1..1 Reference(Resource) The actual data reference
Consent.provision.expression 0..1 Expression A computable expression of the consent
Consent.provision.provision 0..* See provision (Consent) Nested Exception Provisions

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base required All Languages 📍5.0.0 FHIR Std.
Consent.status Base required Consent State Codes 📍0.11.1 This IG
Consent.category Base example Consent Category Codes 📍5.0.0 FHIR Std.
Consent.sourceAttachment.​contentType Base required Mime Types 📍5.0.0 FHIR Std.
Consent.sourceAttachment.​language Base required All Languages 📍5.0.0 FHIR Std.
Consent.regulatoryBasis Base preferred Consent policies 📍0.11.1 This IG
Consent.regulatoryBasis:dhpRegulatoryBasis Base required Consent policies 📍0.11.1 This IG
Consent.verification.​verificationType Base example Consent Vefication Codes 📍5.0.0 FHIR Std.
Consent.decision Base required Consent provision type 📍0.11.1 This IG
Consent.provision.actor.​role Base extensible Participation Role Type 📍5.0.0 FHIR Std.
Consent.provision.action Base preferred Possible consent actions 📍0.11.1 This IG
Consent.provision.action:dhpAction Base required Possible consent actions 📍0.11.1 This IG
Consent.provision.securityLabel Base example Example set of Security Labels 📍5.0.0 FHIR Std.
Consent.provision.purpose Base extensible Consent purpose of use 📍0.11.1 This IG
Consent.provision.documentType Base preferred Consent Content Class 📍5.0.0 FHIR Std.
Consent.provision.resourceType Base extensible Resource Types 📍5.0.0 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍5.0.0 FHIR Std.
Consent.provision.data.​meaning Base required Consent Data Meaning 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Consent

Summary

Must-Support: 14 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Consent.regulatoryBasis
  • The element 1 is sliced based on the value of Consent.provision.action

 

Other representations of profile: CSV, Excel, Schematron

Quick Start

Common API interactions for this profile. Requests require a JWT access token - see Security and authentication. [base] is the FHIR server base URL; | separates a code system from its value and must be URL-encoded as %7C.

Read by server id

GET [base]/Consent/[id]

Find a patient's consent decisions

GET [base]/Consent?patient=Patient/[id]
GET [base]/Consent?patient=Patient/[id]&status=active
GET [base]/Consent?patient=Patient/[id]&category=http://terminology.hl7.org/CodeSystem/consentcategorycodes%7Cinfa
GET [base]/Consent?patient=Patient/[id]&period=ge2025-01-01
GET [base]/Consent?patient=Patient/[id]&date=ge2025-01-01

Create (opt a patient out - absent a Consent, sharing is permitted by default)

POST [base]/Consent
{
  "resourceType": "Consent",
  "meta": { "profile": [ "https://dhp.uz/fhir/core/StructureDefinition/uz-core-consent" ] },
  "status": "active",
  "subject": { "reference": "Patient/[id]" },
  "decision": "deny",
  ...
}

Update (e.g. the patient opts out, or re-grants) - PUT the full resource back with the new decision:

PUT [base]/Consent/[id]
If-Match: W/"3"   # the ETag from your last read; 412 if it changed since

Consent is normally set by the patient in the portal. A denied consent causes data requests to be refused with HTTP 403; clients should handle that outcome.

See the CapabilityStatement for the full list of supported search parameters.