JohnMoehrke RelatedPerson Consent
0.1.0 - ci-build
JohnMoehrke RelatedPerson Consent, published by John Moehrke (himself). 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/JohnMoehrke/RelatedPersonConsent/ and changes regularly. See the Directory of published versions
Official URL: http://johnmoehrke.github.io/RelatedPersonConsent/StructureDefinition/RelatedPersonConsent | Version: 0.1.0 | |||
Draft as of 2024-08-30 | Computable Name: RelatedPersonConsent |
This defines the constraints on a Consent to indicate that a Patient has agreed and authorizes a Related Person.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
modifierExtension | 0..0 | |||
status | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Required Pattern: active | |
scope | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
Slices for category | 3..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by value:$this | |
category:representative | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://johnmoehrke.github.io/RelatedPersonConsent/CodeSystem/AuthorizedCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RelatedPersonAuthorizing | |
category:relInfo | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 64292-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Release of information consent | |
category:idscl | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL | |
patient | 1..1 | Reference(Patient) | Who the consent applies to | |
dateTime | 1..1 | dateTime | When this Consent was created or indexed | |
performer | 1..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | |
organization | 1..* | Reference(Organization) | Custodian of the consent | |
source[x] | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | would point at the Consent paperwork signed by the Patient | |
provision | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | |
type | 0..1 | code | deny | permit Required Pattern: permit | |
actor | 1..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |
role | 1..1 | CodeableConcept | How the actor is involved Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DELEGATEE | |
reference | 1..1 | Reference(RelatedPerson) | Resource for the actor (or group, by role) | |
action | 0..* | CodeableConcept | may indicate subset of actions allowed | |
securityLabel | 0..* | Coding | may indicate a subset of data tags allowed | |
purpose | 0..* | Coding | may indicate a subset of access purposes of use allowed Binding: Authorization purposes for delegation access valueset (required) | |
class | 0..* | Coding | may indicate a subset of classes of data allowed | |
dataPeriod | 0..1 | Period | may indicate a data period allowed | |
data | 0..* | BackboneElement | may indicate specific data instances allowed | |
provision | 0..* | may indicate exceptions, specific rules disallowed | ||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Consent.provision.purpose | required | AuthPurposesVShttp://johnmoehrke.github.io/RelatedPersonConsent/ValueSet/AuthPurposesVS from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | 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 ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
status | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active |
scope | ?!Σ | 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 |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
Slices for category | Σ | 3..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by value:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. |
category:representative | Σ | 1..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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://johnmoehrke.github.io/RelatedPersonConsent/CodeSystem/AuthorizedCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RelatedPersonAuthorizing | |
category:relInfo | Σ | 1..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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 64292-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Release of information consent | |
category:idscl | Σ | 1..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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL | |
patient | Σ | 1..1 | Reference(Patient) | Who the consent applies to |
dateTime | Σ | 1..1 | dateTime | When this Consent was created or indexed |
performer | Σ | 1..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules |
organization | Σ | 1..* | Reference(Organization) | Custodian of the consent |
source[x] | Σ | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | would point at the Consent paperwork signed by the Patient |
provision | Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Required Pattern: permit |
actor | 1..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | 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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DELEGATEE | |
reference | 1..1 | Reference(RelatedPerson) | Resource for the actor (or group, by role) | |
action | Σ | 0..* | CodeableConcept | may indicate subset of actions allowed Binding: ConsentActionCodes (example): Detailed codes for the consent action. |
securityLabel | Σ | 0..* | Coding | may indicate a subset of data tags allowed Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
purpose | Σ | 0..* | Coding | may indicate a subset of access purposes of use allowed Binding: Authorization purposes for delegation access valueset (required) |
class | Σ | 0..* | Coding | may indicate a subset of classes of data allowed Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. |
dataPeriod | Σ | 0..1 | Period | may indicate a data period allowed |
data | Σ | 0..* | BackboneElement | may indicate specific data instances allowed |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. |
reference | Σ | 1..1 | Reference(Resource) | The actual data reference |
provision | 0..* | See provision (Consent) | may indicate exceptions, specific rules disallowed | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Consent.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.3.0 from the FHIR Standard | |
Consent.scope | extensible | Pattern: 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.category:representative | extensible | Pattern: RelatedPersonAuthorizinghttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.category:relInfo | extensible | Pattern: LOINC Code 64292-6("Release of information consent")http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.category:idscl | extensible | Pattern: IDSCLhttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.provision.type | required | Pattern: permithttp://hl7.org/fhir/ValueSet/consent-provision-type|4.3.0 from the FHIR Standard | |
Consent.provision.actor.role | extensible | Pattern: DELEGATEEhttp://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 | required | AuthPurposesVShttp://johnmoehrke.github.io/RelatedPersonConsent/ValueSet/AuthPurposesVS from this IG | |
Consent.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-class from the FHIR Standard | |
Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.3.0 from the FHIR Standard |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Consent | 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 ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
identifier | Σ | 0..* | Identifier | Identifier for this record (external references) | ||||
status | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active | ||||
scope | ?!Σ | 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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
Slices for category | Σ | 3..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by value:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | ||||
category:representative | Σ | 1..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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://johnmoehrke.github.io/RelatedPersonConsent/CodeSystem/AuthorizedCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RelatedPersonAuthorizing | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
category:relInfo | Σ | 1..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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 64292-6 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Release of information consent | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
category:idscl | Σ | 1..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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
patient | Σ | 1..1 | Reference(Patient) | Who the consent applies to | ||||
dateTime | Σ | 1..1 | dateTime | When this Consent was created or indexed | ||||
performer | Σ | 1..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | ||||
organization | Σ | 1..* | Reference(Organization) | Custodian of the consent | ||||
source[x] | Σ | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | would point at the Consent paperwork signed by the Patient | ||||
policy | 0..* | BackboneElement | Policies covered by this consent | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
authority | C | 0..1 | uri | Enforcement source for policy | ||||
uri | C | 0..1 | uri | Specific policy covered by this consent | ||||
policyRule | ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
verification | Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
verified | Σ | 1..1 | boolean | Has been verified | ||||
verifiedWith | 0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
verificationDate | 0..1 | dateTime | When consent verified | |||||
provision | Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Required Pattern: permit | ||||
period | Σ | 0..1 | Period | Timeframe for this rule | ||||
actor | 1..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
role | 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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DELEGATEE | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
reference | 1..1 | Reference(RelatedPerson) | Resource for the actor (or group, by role) | |||||
action | Σ | 0..* | CodeableConcept | may indicate subset of actions allowed Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
securityLabel | Σ | 0..* | Coding | may indicate a subset of data tags allowed Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
purpose | Σ | 0..* | Coding | may indicate a subset of access purposes of use allowed Binding: Authorization purposes for delegation access valueset (required) | ||||
class | Σ | 0..* | Coding | may indicate a subset of classes of data allowed Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
code | Σ | 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. | ||||
dataPeriod | Σ | 0..1 | Period | may indicate a data period allowed | ||||
data | Σ | 0..* | BackboneElement | may indicate specific data instances allowed | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
reference | Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
provision | 0..* | See provision (Consent) | may indicate exceptions, specific rules disallowed | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Consent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Consent.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.3.0 from the FHIR Standard | ||||
Consent.scope | extensible | Pattern: 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.category:representative | extensible | Pattern: RelatedPersonAuthorizinghttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.category:relInfo | extensible | Pattern: LOINC Code 64292-6("Release of information consent")http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.category:idscl | extensible | Pattern: IDSCLhttp://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 | Pattern: permithttp://hl7.org/fhir/ValueSet/consent-provision-type|4.3.0 from the FHIR Standard | ||||
Consent.provision.actor.role | extensible | Pattern: DELEGATEEhttp://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 | required | AuthPurposesVShttp://johnmoehrke.github.io/RelatedPersonConsent/ValueSet/AuthPurposesVS from this IG | ||||
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.3.0 from the FHIR Standard |
Differential View
This structure is derived from Consent
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | 0..* | Consent | A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
modifierExtension | 0..0 | |||
status | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Required Pattern: active | |
scope | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
Slices for category | 3..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by value:$this | |
category:representative | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://johnmoehrke.github.io/RelatedPersonConsent/CodeSystem/AuthorizedCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RelatedPersonAuthorizing | |
category:relInfo | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 64292-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Release of information consent | |
category:idscl | 1..1 | CodeableConcept | Classification of the consent statement - for indexing/retrieval Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL | |
patient | 1..1 | Reference(Patient) | Who the consent applies to | |
dateTime | 1..1 | dateTime | When this Consent was created or indexed | |
performer | 1..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | |
organization | 1..* | Reference(Organization) | Custodian of the consent | |
source[x] | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | would point at the Consent paperwork signed by the Patient | |
provision | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | |
type | 0..1 | code | deny | permit Required Pattern: permit | |
actor | 1..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |
role | 1..1 | CodeableConcept | How the actor is involved Required Pattern: At least the following | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DELEGATEE | |
reference | 1..1 | Reference(RelatedPerson) | Resource for the actor (or group, by role) | |
action | 0..* | CodeableConcept | may indicate subset of actions allowed | |
securityLabel | 0..* | Coding | may indicate a subset of data tags allowed | |
purpose | 0..* | Coding | may indicate a subset of access purposes of use allowed Binding: Authorization purposes for delegation access valueset (required) | |
class | 0..* | Coding | may indicate a subset of classes of data allowed | |
dataPeriod | 0..1 | Period | may indicate a data period allowed | |
data | 0..* | BackboneElement | may indicate specific data instances allowed | |
provision | 0..* | may indicate exceptions, specific rules disallowed | ||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Consent.provision.purpose | required | AuthPurposesVShttp://johnmoehrke.github.io/RelatedPersonConsent/ValueSet/AuthPurposesVS from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Consent | 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 ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
status | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active |
scope | ?!Σ | 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 |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |
Slices for category | Σ | 3..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by value:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. |
category:representative | Σ | 1..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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://johnmoehrke.github.io/RelatedPersonConsent/CodeSystem/AuthorizedCodes | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RelatedPersonAuthorizing | |
category:relInfo | Σ | 1..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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 64292-6 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Release of information consent | |
category:idscl | Σ | 1..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. Required Pattern: At least the following |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL | |
patient | Σ | 1..1 | Reference(Patient) | Who the consent applies to |
dateTime | Σ | 1..1 | dateTime | When this Consent was created or indexed |
performer | Σ | 1..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules |
organization | Σ | 1..* | Reference(Organization) | Custodian of the consent |
source[x] | Σ | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | would point at the Consent paperwork signed by the Patient |
provision | Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Required Pattern: permit |
actor | 1..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
role | 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 | |
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DELEGATEE | |
reference | 1..1 | Reference(RelatedPerson) | Resource for the actor (or group, by role) | |
action | Σ | 0..* | CodeableConcept | may indicate subset of actions allowed Binding: ConsentActionCodes (example): Detailed codes for the consent action. |
securityLabel | Σ | 0..* | Coding | may indicate a subset of data tags allowed Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. |
purpose | Σ | 0..* | Coding | may indicate a subset of access purposes of use allowed Binding: Authorization purposes for delegation access valueset (required) |
class | Σ | 0..* | Coding | may indicate a subset of classes of data allowed Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. |
dataPeriod | Σ | 0..1 | Period | may indicate a data period allowed |
data | Σ | 0..* | BackboneElement | may indicate specific data instances allowed |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. |
reference | Σ | 1..1 | Reference(Resource) | The actual data reference |
provision | 0..* | See provision (Consent) | may indicate exceptions, specific rules disallowed | |
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Consent.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.3.0 from the FHIR Standard | |
Consent.scope | extensible | Pattern: 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.category:representative | extensible | Pattern: RelatedPersonAuthorizinghttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.category:relInfo | extensible | Pattern: LOINC Code 64292-6("Release of information consent")http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.category:idscl | extensible | Pattern: IDSCLhttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | |
Consent.provision.type | required | Pattern: permithttp://hl7.org/fhir/ValueSet/consent-provision-type|4.3.0 from the FHIR Standard | |
Consent.provision.actor.role | extensible | Pattern: DELEGATEEhttp://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 | required | AuthPurposesVShttp://johnmoehrke.github.io/RelatedPersonConsent/ValueSet/AuthPurposesVS from this IG | |
Consent.provision.class | extensible | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-class from the FHIR Standard | |
Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|4.3.0 from the FHIR Standard |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Consent | 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 ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): IETF language tag
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources dom-r4b: Containing new R4B resources within R4 resources may cause interoperability issues if instances are shared with R4 systems | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
identifier | Σ | 0..* | Identifier | Identifier for this record (external references) | ||||
status | ?!Σ | 1..1 | code | draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. Required Pattern: active | ||||
scope | ?!Σ | 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 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: patient-privacy | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
Slices for category | Σ | 3..* | CodeableConcept | Classification of the consent statement - for indexing/retrieval Slice: Unordered, Open by value:$this Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. | ||||
category:representative | Σ | 1..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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://johnmoehrke.github.io/RelatedPersonConsent/CodeSystem/AuthorizedCodes | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RelatedPersonAuthorizing | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
category:relInfo | Σ | 1..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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: 64292-6 | |||||
display | 1..1 | string | Representation defined by the system Fixed Value: Release of information consent | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
category:idscl | Σ | 1..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. Required Pattern: At least the following | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ActCode | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: IDSCL | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
patient | Σ | 1..1 | Reference(Patient) | Who the consent applies to | ||||
dateTime | Σ | 1..1 | dateTime | When this Consent was created or indexed | ||||
performer | Σ | 1..* | Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Who is agreeing to the policy and rules | ||||
organization | Σ | 1..* | Reference(Organization) | Custodian of the consent | ||||
source[x] | Σ | 0..1 | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | would point at the Consent paperwork signed by the Patient | ||||
policy | 0..* | BackboneElement | Policies covered by this consent | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
authority | C | 0..1 | uri | Enforcement source for policy | ||||
uri | C | 0..1 | uri | Specific policy covered by this consent | ||||
policyRule | ΣC | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples. | ||||
verification | Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
verified | Σ | 1..1 | boolean | Has been verified | ||||
verifiedWith | 0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
verificationDate | 0..1 | dateTime | When consent verified | |||||
provision | Σ | 1..1 | BackboneElement | Constraints to the base Consent.policyRule | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
type | Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Required Pattern: permit | ||||
period | Σ | 0..1 | Period | Timeframe for this rule | ||||
actor | 1..* | BackboneElement | Who|what controlled by this rule (or group, by role) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
role | 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 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-RoleCode | |||||
version | 0..1 | string | Version of the system - if relevant | |||||
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DELEGATEE | |||||
display | 0..1 | string | Representation defined by the system | |||||
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
text | 0..1 | string | Plain text representation of the concept | |||||
reference | 1..1 | Reference(RelatedPerson) | Resource for the actor (or group, by role) | |||||
action | Σ | 0..* | CodeableConcept | may indicate subset of actions allowed Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
securityLabel | Σ | 0..* | Coding | may indicate a subset of data tags allowed Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
purpose | Σ | 0..* | Coding | may indicate a subset of access purposes of use allowed Binding: Authorization purposes for delegation access valueset (required) | ||||
class | Σ | 0..* | Coding | may indicate a subset of classes of data allowed Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers. | ||||
code | Σ | 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. | ||||
dataPeriod | Σ | 0..1 | Period | may indicate a data period allowed | ||||
data | Σ | 0..* | BackboneElement | may indicate specific data instances allowed | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
meaning | Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
reference | Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
provision | 0..* | See provision (Consent) | may indicate exceptions, specific rules disallowed | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI | |||
Consent.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Consent.status | required | Pattern: activehttp://hl7.org/fhir/ValueSet/consent-state-codes|4.3.0 from the FHIR Standard | ||||
Consent.scope | extensible | Pattern: 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.category:representative | extensible | Pattern: RelatedPersonAuthorizinghttp://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.category:relInfo | extensible | Pattern: LOINC Code 64292-6("Release of information consent")http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard | ||||
Consent.category:idscl | extensible | Pattern: IDSCLhttp://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 | Pattern: permithttp://hl7.org/fhir/ValueSet/consent-provision-type|4.3.0 from the FHIR Standard | ||||
Consent.provision.actor.role | extensible | Pattern: DELEGATEEhttp://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 | required | AuthPurposesVShttp://johnmoehrke.github.io/RelatedPersonConsent/ValueSet/AuthPurposesVS from this IG | ||||
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.3.0 from the FHIR Standard |
Other representations of profile: CSV, Excel, Schematron