Documentation Index
Fetch the complete documentation index at: https://docs.metriport.com/llms.txt
Use this file to discover all available pages before exploring further.
Properties
| Name | Required | Type | Description |
|---|
| identifier | No | Identifier[] | Identifier for this record (external references) |
| status | Yes | code | draft / proposed / active / rejected / inactive / entered-in-error |
| scope | Yes | CodeableConcept | Which of the four areas this resource covers (extensible) |
| category | Yes | CodeableConcept[] | Classification of the consent statement - for indexing/retrieval |
| patient | No | Reference<Patient> | Who the consent applies to |
| dateTime | No | dateTime | When this Consent was created or indexed |
| performer | No | Reference<Organization / Patient / Practitioner / RelatedPerson / PractitionerRole>[] | Who is agreeing to the policy and rules |
| organization | No | Reference<Organization>[] | Custodian of the consent |
| source[x] | No | Attachment, Reference<Consent / DocumentReference / Contract / QuestionnaireResponse> | Source from which this consent is taken |
| policy | No | ConsentPolicy | Policies covered by this consent |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - authority | No | uri | Enforcement source for policy |
| - uri | No | uri | Specific policy covered by this consent |
| policyRule | No | CodeableConcept | Regulation that this consents to |
| verification | No | ConsentVerification | Consent Verified by patient or family |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - verified | Yes | boolean | Has been verified |
| - verifiedWith | No | Reference<Patient / RelatedPerson> | Person who verified |
| - verificationDate | No | dateTime | When consent verified |
| provision | No | ConsentProvision | Constraints to the base Consent.policyRule |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - type | No | code | deny / permit |
| - period | No | Period | Timeframe for this rule |
| - actor | No | ConsentProvisionActor | Who/what controlled by this rule (or group, by role) |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - role | Yes | CodeableConcept | How the actor is involved |
| - reference | Yes | Reference<Device / Group / CareTeam / Organization / Patient / Practitioner / RelatedPerson / PractitionerRole> | Resource for the actor (or group, by role) |
| - action | No | CodeableConcept[] | Actions controlled by this rule |
| - securityLabel | No | Coding[] | Security Labels that define affected resources |
| - purpose | No | Coding[] | Context of activities covered by this rule |
| - class | No | Coding[] | e.g. Resource Type, Profile, CDA, etc. |
| - code | No | CodeableConcept[] | e.g. LOINC or SNOMED CT code, etc. in the content |
| - dataPeriod | No | Period | Timeframe for data controlled by this rule |
| - data | No | ConsentProvisionData | Data controlled by this rule |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - meaning | Yes | code | instance / related / dependents / authoredby |
| - reference | Yes | Reference<Resource> | The actual data reference |
| - provision | No | [] | Nested Exception Rules |
Search Parameters
| Name | Type | Description | Expression |
|---|
| date | date | When this Consent was created or indexed | Consent.dateTime |
| identifier | token | Identifier for this record (external references) | Consent.identifier |
| patient | reference | Who the consent applies to | Consent.patient |
| action | token | Actions controlled by this rule | Consent.provision.action |
| actor | reference | Resource for the actor (or group, by role) | Consent.provision.actor.reference |
| category | token | Classification of the consent statement - for indexing/retrieval | Consent.category |
| consentor | reference | Who is agreeing to the policy and rules | Consent.performer |
| data | reference | The actual data reference | Consent.provision.data.reference |
| organization | reference | Custodian of the consent | Consent.organization |
| period | date | Timeframe for this rule | Consent.provision.period |
| purpose | token | Context of activities covered by this rule | Consent.provision.purpose |
| scope | token | Which of the four areas this resource covers (extensible) | Consent.scope |
| security-label | token | Security Labels that define affected resources | Consent.provision.securityLabel |
| source-reference | reference | Search by reference to a Consent, DocumentReference, Contract or QuestionnaireResponse | Consent.source |
| status | token | draft / proposed / active / rejected / inactive / entered-in-error | Consent.status |
Inherited Properties
| Name | Required | Type | Description |
|---|
| id | No | string | Logical id of this artifact |
| meta | No | Meta | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | Narrative | Text summary of the resource, for human interpretation |
| contained | No | Resource[] | Contained, inline Resources |
| extension | No | Extension[] | Additional content defined by implementations |
| modifierExtension | No | Extension[] | Extensions that cannot be ignored |
