Scalable Consent Management, published by HL7 International / Community Based Collaborative Care. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-consent-management/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTConsent | Version: 0.1.0 | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: FASTConsent |
This profile captures the details of a Patient's Consent.
The following data elements must always be present or must be supported if the data is present in the sending system Must Support. They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.
Each Consent Must Have:
Each Consent Must Support:
Each Consent MUST NOT provide:
Since a FHIR reference can contain a RESTful id to a patient, organization, practitioner, or related person, and those RESTful ids may not be useful once a Consent instance has propogated to other consent servers, this guide requires that an external identifier for those participants SHALL be populated. The RESTful id can also be sent but it is not necessary since the mandatory identifier conveys the identity of the participant. The FHIR additionalIdentifier extension is also included in the Reference to allow for multiple identifiers for participants to be conveyed.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..* | Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. |
![]() ![]() ![]() |
?!SΣ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. |
![]() ![]() ![]() |
SΣ | 1..1 | FASTReference(US Core Patient Profile) | Who the consent applies to |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When this Consent was created or indexed |
![]() ![]() ![]() |
SΣ | 1..* | FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile) | Who is agreeing to the policy and rules |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core QuestionnaireResponse Profile | FASTDocumentReference) | Source from which this consent is taken |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Policies covered by this consent |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SC | 1..1 | uri | Specific policy covered by this consent |
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (3.1.0) (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Nested Exception Rules |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() |
Path | Conformance | ValueSet / Code | URI |
Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 From the FHIR Standard | |
Consent.scope | extensible | Pattern Value: patient-privacyhttp://hl7.org/fhir/ValueSet/consent-scope From the FHIR Standard | |
Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category From the FHIR Standard | |
Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 From the FHIR Standard | |
Consent.provision.actor.role | extensible | Pattern Value: IRCPhttp://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard | |
Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse|3.1.0 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Consent | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
ppc-2 | error | Consent | IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() | |
ppc-3 | error | Consent | IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not() | |
ppc-4 | error | Consent | IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() | |
ppc-5 | error | Consent | IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() |
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..* | Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller |
![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier for this record (external references) |
![]() ![]() ![]() |
S | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval |
![]() ![]() ![]() |
S | 1..1 | FASTReference(US Core Patient Profile) | Who the consent applies to |
![]() ![]() ![]() |
S | 1..1 | dateTime | When this Consent was created or indexed |
![]() ![]() ![]() |
S | 1..* | FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile) | Who is agreeing to the policy and rules |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | Reference(US Core QuestionnaireResponse Profile | FASTDocumentReference) | Source from which this consent is taken |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Policies covered by this consent |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Specific policy covered by this consent |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
![]() ![]() ![]() ![]() |
S | 1..1 | code | deny | permit |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Context of activities covered by this rule |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Nested Exception Rules |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..* | Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee | ||||
![]() ![]() ![]() ![]() |
S | 0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager | ||||
![]() ![]() ![]() ![]() |
S | 0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | FASTReference(US Core Patient Profile) | Who the consent applies to | ||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When this Consent was created or indexed | ||||
![]() ![]() ![]() |
SΣ | 1..* | FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile) | Who is agreeing to the policy and rules | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core QuestionnaireResponse Profile | FASTDocumentReference) | Source from which this consent is taken | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Policies covered by this consent | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | uri | Enforcement source for policy | ||||
![]() ![]() ![]() ![]() |
SC | 1..1 | uri | Specific policy covered by this consent | ||||
![]() ![]() ![]() |
ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Has been verified | ||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When consent verified | |||||
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for this rule | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (3.1.0) (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for data controlled by this rule | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Nested Exception Rules | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for this rule | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (3.1.0) (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for data controlled by this rule | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Consent.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 From the FHIR Standard | ||||
Consent.scope | extensible | Pattern Value: patient-privacyhttp://hl7.org/fhir/ValueSet/consent-scope From the FHIR Standard | ||||
Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category From the FHIR Standard | ||||
Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policy From the FHIR Standard | ||||
Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 From the FHIR Standard | ||||
Consent.provision.actor.role | extensible | Pattern Value: IRCPhttp://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard | ||||
Consent.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-action From the FHIR Standard | ||||
Consent.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | ||||
Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse|3.1.0 | ||||
Consent.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-class From the FHIR Standard | ||||
Consent.provision.code | example | ConsentContentCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-code From the FHIR Standard | ||||
Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 From the FHIR Standard | ||||
Consent.provision.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 From the FHIR Standard | ||||
Consent.provision.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard | ||||
Consent.provision.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-action From the FHIR Standard | ||||
Consent.provision.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | ||||
Consent.provision.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse|3.1.0 | ||||
Consent.provision.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-class From the FHIR Standard | ||||
Consent.provision.provision.code | example | ConsentContentCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-code From the FHIR Standard | ||||
Consent.provision.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Consent | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
ppc-2 | error | Consent | IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() | |
ppc-3 | error | Consent | IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not() | |
ppc-4 | error | Consent | IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() | |
ppc-5 | error | Consent | IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() |
This structure is derived from Consent
Summary
Mandatory: 9 elements(1 nested mandatory element)
Must-Support: 20 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..* | Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} |
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. |
![]() ![]() ![]() |
?!SΣ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. |
![]() ![]() ![]() |
SΣ | 1..1 | FASTReference(US Core Patient Profile) | Who the consent applies to |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When this Consent was created or indexed |
![]() ![]() ![]() |
SΣ | 1..* | FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile) | Who is agreeing to the policy and rules |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core QuestionnaireResponse Profile | FASTDocumentReference) | Source from which this consent is taken |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Policies covered by this consent |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SC | 1..1 | uri | Specific policy covered by this consent |
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) |
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (3.1.0) (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Nested Exception Rules |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() |
Path | Conformance | ValueSet / Code | URI |
Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 From the FHIR Standard | |
Consent.scope | extensible | Pattern Value: patient-privacyhttp://hl7.org/fhir/ValueSet/consent-scope From the FHIR Standard | |
Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category From the FHIR Standard | |
Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 From the FHIR Standard | |
Consent.provision.actor.role | extensible | Pattern Value: IRCPhttp://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard | |
Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse|3.1.0 |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Consent | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
ppc-2 | error | Consent | IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() | |
ppc-3 | error | Consent | IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not() | |
ppc-4 | error | Consent | IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() | |
ppc-5 | error | Consent | IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() |
Differential View
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
![]() ![]() ![]() ![]() |
S | 1..* | Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager |
![]() ![]() ![]() ![]() |
S | 0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller |
![]() ![]() ![]() |
S | 1..1 | Identifier | Identifier for this record (external references) |
![]() ![]() ![]() |
S | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Required Pattern: At least the following |
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
![]() ![]() ![]() |
S | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval |
![]() ![]() ![]() |
S | 1..1 | FASTReference(US Core Patient Profile) | Who the consent applies to |
![]() ![]() ![]() |
S | 1..1 | dateTime | When this Consent was created or indexed |
![]() ![]() ![]() |
S | 1..* | FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile) | Who is agreeing to the policy and rules |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | Reference(US Core QuestionnaireResponse Profile | FASTDocumentReference) | Source from which this consent is taken |
![]() ![]() ![]() |
S | 0..* | BackboneElement | Policies covered by this consent |
![]() ![]() ![]() ![]() |
S | 1..1 | uri | Specific policy covered by this consent |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
![]() ![]() ![]() ![]() |
S | 1..1 | code | deny | permit |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Required Pattern: At least the following |
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) |
![]() ![]() ![]() ![]() |
S | 0..* | Coding | Context of activities covered by this rule |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Nested Exception Rules |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
C | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5 | ||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
S | 1..* | Reference(CareTeam | HealthcareService | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.grantee | ||||
![]() ![]() ![]() ![]() |
S | 0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.manager | ||||
![]() ![]() ![]() ![]() |
S | 0..* | Reference(HealthcareService | Organization | Patient | Practitioner) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Consent.controller | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Identifier | Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"} | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | FASTReference(US Core Patient Profile) | Who the consent applies to | ||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | When this Consent was created or indexed | ||||
![]() ![]() ![]() |
SΣ | 1..* | FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile) | Who is agreeing to the policy and rules | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core QuestionnaireResponse Profile | FASTDocumentReference) | Source from which this consent is taken | ||||
![]() ![]() ![]() |
S | 0..* | BackboneElement | Policies covered by this consent | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | uri | Enforcement source for policy | ||||
![]() ![]() ![]() ![]() |
SC | 1..1 | uri | Specific policy covered by this consent | ||||
![]() ![]() ![]() |
ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Has been verified | ||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | When consent verified | |||||
![]() ![]() ![]() |
SΣ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for this rule | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: IRCP | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (3.1.0) (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for data controlled by this rule | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Nested Exception Rules | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for this rule | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Context of activities covered by this rule Binding: PurposeOfUse (3.1.0) (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for data controlled by this rule | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Data controlled by this rule | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
![]() |
Path | Conformance | ValueSet / Code | URI | |||
Consent.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages From the FHIR Standard
| ||||
Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 From the FHIR Standard | ||||
Consent.scope | extensible | Pattern Value: patient-privacyhttp://hl7.org/fhir/ValueSet/consent-scope From the FHIR Standard | ||||
Consent.category | extensible | ConsentCategoryCodeshttp://hl7.org/fhir/ValueSet/consent-category From the FHIR Standard | ||||
Consent.policyRule | extensible | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policy From the FHIR Standard | ||||
Consent.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 From the FHIR Standard | ||||
Consent.provision.actor.role | extensible | Pattern Value: IRCPhttp://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard | ||||
Consent.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-action From the FHIR Standard | ||||
Consent.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | ||||
Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse|3.1.0 | ||||
Consent.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-class From the FHIR Standard | ||||
Consent.provision.code | example | ConsentContentCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-code From the FHIR Standard | ||||
Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 From the FHIR Standard | ||||
Consent.provision.provision.type | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 From the FHIR Standard | ||||
Consent.provision.provision.actor.role | extensible | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard | ||||
Consent.provision.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-action From the FHIR Standard | ||||
Consent.provision.provision.securityLabel | extensible | All Security Labelshttp://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard | ||||
Consent.provision.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse|3.1.0 | ||||
Consent.provision.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-class From the FHIR Standard | ||||
Consent.provision.provision.code | example | ConsentContentCodes(a valid code from LOINC)http://hl7.org/fhir/ValueSet/consent-content-code From the FHIR Standard | ||||
Consent.provision.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 From the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Consent | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Consent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Consent | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Consent | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ppc-1 | error | Consent | Either a Policy or PolicyRule : policy.exists() or policyRule.exists() | |
ppc-2 | error | Consent | IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not() | |
ppc-3 | error | Consent | IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not() | |
ppc-4 | error | Consent | IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not() | |
ppc-5 | error | Consent | IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not() |
This structure is derived from Consent
Summary
Mandatory: 9 elements(1 nested mandatory element)
Must-Support: 20 elements
Prohibited: 2 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
Below is an overview of the required Server RESTful FHIR interactions for this profile - for example, search and read operations - when supporting the FAST Consent interactions to access this profile's information (Profile Support + Interaction Support). See the FAST Consent Server CapabilityStatement (TBD) for a complete list of supported RESTful interactions for this IG.
The following search parameters and search parameter combinations SHALL be supported:
SHALL support both read Consent by id
AND Consent search using the _id
search parameter:
GET [base]/Consent/[id]
or GET [base]/Consent?_id=[id]
Example:
Implementation Notes: (how to search by the logical id of the resource)
SHALL support searching a consent by an identifier such as a CDA consent document using the identifier
search parameter:
GET [base]/Consent?identifier={system|}[code]
Example:
Implementation Notes: Fetches a bundle containing any Consent resources matching the identifier (how to search by token)
SHALL support searching a consent by a patient using the patient
search parameter:
GET [base]/Consent?patient={type\}[id]
Example:
Implementation Notes: Fetches a bundle containing any Consent resources matching the patient (how to search by reference)
SHALL support searching using the combination of the patient
and status
search parameters:
GET [base]/Patient?patient={type\}[id]&status=[code]
Example:
Implementation Notes: Fetches a bundle of all Consent resources matching the specified patient and status (how to search by reference and how to search by token)
The following search parameter combinations SHOULD be supported:
SHOULD support searching using the combination of the patient
and date
search parameters:
GET [base]/Patient?patient={type\}[id]&date=[date]
Example:
Implementation Notes: Fetches a bundle of all Patient resources matching the specified patient and date (how to search by reference and how to search by date)