JohnMoehrke RelatedPerson Consent
0.1.0 - ci-build International flag

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

Resource Profile: Consent profile for a RelatedPerson relationship

Official URL: http://johnmoehrke.github.io/RelatedPersonConsent/StructureDefinition/RelatedPersonConsent Version: 0.1.0
Standards status: Trial-use Maturity Level: 1 Computable Name: RelatedPersonConsent
Other Identifiers: OID:1.3.6.1.4.1.66281.5.42.4

This defines the constraints on a Consent to indicate that a Patient has agreed and authorizes a Related Person.

  • status - would indicate active
  • category - would indicate patient consent specifically a delegation of authority
  • patient - would indicate the Patient resource reference for the given patient
  • dateTime - would indicate when the privacy policy was presented
  • performer - would indicate the Patient resource if the patient was presented, a RelatedPerson for parent or guardian
  • organization - would indicate the Organization who presented the privacy policy, and which is going to enforce that privacy policy
  • source - would point at the specific signed consent by the patient
  • policy.uri - would indicate the privacy policy that was presented. Usually, the url to the version specific policy
  • provision.type - permit - authorizes the RelatedPerson as a delegatee; nested provisions may deny specific exceptions.
  • provision.actor.reference - would indicate the RelatedPerson resource
  • provision.actor.role - would indicate this actor is delegated authority
  • provision.purpose - would indicate the purpose of the information activity; it does not by itself establish that the RelatedPerson is the clinician or decision-maker for that activity.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.status This element is a modifier element. This element is included in summaries. 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Required Pattern: active (extensions allowed)
Consent.scope This element is a modifier element. This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}
Consent.Slices for category This element is included in summaries. 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.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for category.category:representative This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://johnmoehrke.github.io/RelatedPersonConsent/CodeSystem/AuthorizedCodes",
      "code" : "RelatedPersonAuthorizing"
    }
  ]
}
Consent.Slices for category.category:relInfo This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "64292-6"
    }
  ]
}
Consent.Slices for category.category:idscl This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
      "code" : "IDSCL"
    }
  ]
}
Consent.patient This element is included in summaries. 1..1 Reference(Patient) Who the consent applies to
Consent.dateTime This element is included in summaries. 1..1 dateTime When this Consent was created or indexed
Consent.performer This element is included in summaries. 1..* Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
Consent.organization This element is included in summaries. 1..* Reference(Organization) Custodian of the consent
Consent.source[x] This element is included in summaries. 0..1 Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) would point at the Consent paperwork signed by the Patient
Consent.provision This element is included in summaries. 1..1 BackboneElement Constraints to the base Consent.policyRule
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.type This element is included in summaries. 1..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Required Pattern: permit (extensions allowed)
Consent.provision.actor 1..* BackboneElement Who|what controlled by this rule (or group, by role)
Consent.provision.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATEE"
    }
  ]
}
Consent.provision.actor.reference 1..1 Reference(RelatedPerson) Resource for the actor (or group, by role)
Consent.provision.action This element is included in summaries. 0..* CodeableConcept may indicate subset of actions allowed
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
Consent.provision.securityLabel This element is included in summaries. 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.
Consent.provision.purpose This element is included in summaries. 0..* Coding may indicate a subset of access purposes of use allowed
Binding: Authorization purposes for delegation access valueset (required)
Consent.provision.class This element is included in summaries. 0..* Coding may indicate a subset of classes of data allowed
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
Consent.provision.dataPeriod This element is included in summaries. 0..1 Period may indicate a data period allowed
Consent.provision.data This element is included in summaries. 0..* BackboneElement may indicate specific data instances allowed
Consent.provision.data.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.data.meaning This element is included in summaries. 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Consent.provision.data.reference This element is included in summaries. 1..1 Reference(Resource) The actual data reference
Consent.provision.provision 0..* See provision (Consent) may indicate exceptions, specific rules disallowed

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:representative Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:relInfo Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:idscl Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.0.1 FHIR Std.
Consent.provision.actor.​role Base extensible SecurityRoleType 📍4.0.1 FHIR Std.
Consent.provision.action Base example Consent Action Codes 📍4.0.1 FHIR Std.
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.provision.purpose Base required Authorization purposes for delegation access valueset 📦0.1.0 This IG
Consent.provision.class Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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
Consent.modifierExtension 0..0 Extension
Consent.status 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Required Pattern: active (extensions allowed)
Consent.scope 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}
Consent.Slices for category 3..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by value:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for category.category:representative 1..1 CodeableConcept Classification of the consent statement - for indexing/retrieval
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://johnmoehrke.github.io/RelatedPersonConsent/CodeSystem/AuthorizedCodes",
      "code" : "RelatedPersonAuthorizing"
    }
  ]
}
Consent.Slices for category.category:relInfo 1..1 CodeableConcept Classification of the consent statement - for indexing/retrieval
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "64292-6"
    }
  ]
}
Consent.Slices for category.category:idscl 1..1 CodeableConcept Classification of the consent statement - for indexing/retrieval
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
      "code" : "IDSCL"
    }
  ]
}
Consent.patient 1..1 Reference(Patient) Who the consent applies to
Consent.dateTime 1..1 dateTime When this Consent was created or indexed
Consent.performer 1..* Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
Consent.organization 1..* Reference(Organization) Custodian of the consent
Consent.source[x] 0..1 Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) would point at the Consent paperwork signed by the Patient
Consent.provision 1..1 BackboneElement Constraints to the base Consent.policyRule
Consent.provision.type 1..1 code deny | permit
Required Pattern: permit (extensions allowed)
Consent.provision.actor 1..* BackboneElement Who|what controlled by this rule (or group, by role)
Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATEE"
    }
  ]
}
Consent.provision.actor.reference 1..1 Reference(RelatedPerson) Resource for the actor (or group, by role)
Consent.provision.action 0..* CodeableConcept may indicate subset of actions allowed
Consent.provision.securityLabel 0..* Coding may indicate a subset of data tags allowed
Consent.provision.purpose 0..* Coding may indicate a subset of access purposes of use allowed
Binding: Authorization purposes for delegation access valueset (required)
Consent.provision.class 0..* Coding may indicate a subset of classes of data allowed
Consent.provision.dataPeriod 0..1 Period may indicate a data period allowed
Consent.provision.data 0..* BackboneElement may indicate specific data instances allowed
Consent.provision.provision 0..* may indicate exceptions, specific rules disallowed

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Consent.provision.purpose Base required Authorization purposes for delegation access valueset 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
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
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
Consent.id This element is included in summaries. 0..1 id Logical id of this artifact
Consent.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Consent.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Consent.contained 0..* Resource Contained, inline Resources
Consent.extension 0..* Extension Additional content defined by implementations
Consent.identifier This element is included in summaries. 0..* Identifier Identifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
Consent.status This element is a modifier element. This element is included in summaries. 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Required Pattern: active (extensions allowed)
Consent.scope This element is a modifier element. This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}
Consent.Slices for category This element is included in summaries. 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.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for category.category:representative This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://johnmoehrke.github.io/RelatedPersonConsent/CodeSystem/AuthorizedCodes",
      "code" : "RelatedPersonAuthorizing"
    }
  ]
}
Consent.Slices for category.category:relInfo This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "64292-6"
    }
  ]
}
Consent.Slices for category.category:idscl This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
      "code" : "IDSCL"
    }
  ]
}
Consent.patient This element is included in summaries. 1..1 Reference(Patient) Who the consent applies to
Consent.dateTime This element is included in summaries. 1..1 dateTime When this Consent was created or indexed
Consent.performer This element is included in summaries. 1..* Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
Consent.organization This element is included in summaries. 1..* Reference(Organization) Custodian of the consent
Consent.source[x] This element is included in summaries. 0..1 Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) would point at the Consent paperwork signed by the Patient
Consent.policy 0..* BackboneElement Policies covered by this consent
Consent.policy.id 0..1 string Unique id for inter-element referencing
Consent.policy.extension 0..* Extension Additional content defined by implementations
Consent.policy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.policy.authority C 0..1 uri Enforcement source for policy
Consent.policy.uri C 0..1 uri Specific policy covered by this consent
Consent.policyRule This element is included in summaries. C 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Consent.verification This element is included in summaries. 0..* BackboneElement Consent Verified by patient or family
Consent.verification.id 0..1 string Unique id for inter-element referencing
Consent.verification.extension 0..* Extension Additional content defined by implementations
Consent.verification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.verification.verified This element is included in summaries. 1..1 boolean Has been verified
Consent.verification.verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified
Consent.verification.verificationDate 0..1 dateTime When consent verified
Consent.provision This element is included in summaries. 1..1 BackboneElement Constraints to the base Consent.policyRule
Consent.provision.id 0..1 string Unique id for inter-element referencing
Consent.provision.extension 0..* Extension Additional content defined by implementations
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.type This element is included in summaries. 1..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Required Pattern: permit (extensions allowed)
Consent.provision.period This element is included in summaries. 0..1 Period Timeframe for this rule
Consent.provision.actor 1..* BackboneElement Who|what controlled by this rule (or group, by role)
Consent.provision.actor.id 0..1 string Unique id for inter-element referencing
Consent.provision.actor.extension 0..* Extension Additional content defined by implementations
Consent.provision.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATEE"
    }
  ]
}
Consent.provision.actor.reference 1..1 Reference(RelatedPerson) Resource for the actor (or group, by role)
Consent.provision.action This element is included in summaries. 0..* CodeableConcept may indicate subset of actions allowed
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
Consent.provision.securityLabel This element is included in summaries. 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.
Consent.provision.purpose This element is included in summaries. 0..* Coding may indicate a subset of access purposes of use allowed
Binding: Authorization purposes for delegation access valueset (required)
Consent.provision.class This element is included in summaries. 0..* Coding may indicate a subset of classes of data allowed
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
Consent.provision.code This element is included in summaries. 0..* CodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
Consent.provision.dataPeriod This element is included in summaries. 0..1 Period may indicate a data period allowed
Consent.provision.data This element is included in summaries. 0..* BackboneElement may indicate specific data instances allowed
Consent.provision.data.id 0..1 string Unique id for inter-element referencing
Consent.provision.data.extension 0..* Extension Additional content defined by implementations
Consent.provision.data.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.data.meaning This element is included in summaries. 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Consent.provision.data.reference This element is included in summaries. 1..1 Reference(Resource) The actual data reference
Consent.provision.provision 0..* See provision (Consent) may indicate exceptions, specific rules disallowed

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:representative Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:relInfo Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:idscl Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.0.1 FHIR Std.
Consent.provision.actor.​role Base extensible SecurityRoleType 📍4.0.1 FHIR Std.
Consent.provision.action Base example Consent Action Codes 📍4.0.1 FHIR Std.
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.provision.purpose Base required Authorization purposes for delegation access valueset 📦0.1.0 This IG
Consent.provision.class Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍4.0.1 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Consent

Summary

Mandatory: 10 elements
Prohibited: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Consent.category

Maturity: 1

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.status This element is a modifier element. This element is included in summaries. 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Required Pattern: active (extensions allowed)
Consent.scope This element is a modifier element. This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}
Consent.Slices for category This element is included in summaries. 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.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for category.category:representative This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://johnmoehrke.github.io/RelatedPersonConsent/CodeSystem/AuthorizedCodes",
      "code" : "RelatedPersonAuthorizing"
    }
  ]
}
Consent.Slices for category.category:relInfo This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "64292-6"
    }
  ]
}
Consent.Slices for category.category:idscl This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
      "code" : "IDSCL"
    }
  ]
}
Consent.patient This element is included in summaries. 1..1 Reference(Patient) Who the consent applies to
Consent.dateTime This element is included in summaries. 1..1 dateTime When this Consent was created or indexed
Consent.performer This element is included in summaries. 1..* Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
Consent.organization This element is included in summaries. 1..* Reference(Organization) Custodian of the consent
Consent.source[x] This element is included in summaries. 0..1 Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) would point at the Consent paperwork signed by the Patient
Consent.provision This element is included in summaries. 1..1 BackboneElement Constraints to the base Consent.policyRule
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.type This element is included in summaries. 1..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Required Pattern: permit (extensions allowed)
Consent.provision.actor 1..* BackboneElement Who|what controlled by this rule (or group, by role)
Consent.provision.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATEE"
    }
  ]
}
Consent.provision.actor.reference 1..1 Reference(RelatedPerson) Resource for the actor (or group, by role)
Consent.provision.action This element is included in summaries. 0..* CodeableConcept may indicate subset of actions allowed
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
Consent.provision.securityLabel This element is included in summaries. 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.
Consent.provision.purpose This element is included in summaries. 0..* Coding may indicate a subset of access purposes of use allowed
Binding: Authorization purposes for delegation access valueset (required)
Consent.provision.class This element is included in summaries. 0..* Coding may indicate a subset of classes of data allowed
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
Consent.provision.dataPeriod This element is included in summaries. 0..1 Period may indicate a data period allowed
Consent.provision.data This element is included in summaries. 0..* BackboneElement may indicate specific data instances allowed
Consent.provision.data.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.data.meaning This element is included in summaries. 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Consent.provision.data.reference This element is included in summaries. 1..1 Reference(Resource) The actual data reference
Consent.provision.provision 0..* See provision (Consent) may indicate exceptions, specific rules disallowed

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:representative Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:relInfo Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:idscl Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.0.1 FHIR Std.
Consent.provision.actor.​role Base extensible SecurityRoleType 📍4.0.1 FHIR Std.
Consent.provision.action Base example Consent Action Codes 📍4.0.1 FHIR Std.
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.provision.purpose Base required Authorization purposes for delegation access valueset 📦0.1.0 This IG
Consent.provision.class Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

Differential View

This structure is derived from Consent

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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
Consent.modifierExtension 0..0 Extension
Consent.status 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Required Pattern: active (extensions allowed)
Consent.scope 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}
Consent.Slices for category 3..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Slice: Unordered, Open by value:$this
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for category.category:representative 1..1 CodeableConcept Classification of the consent statement - for indexing/retrieval
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://johnmoehrke.github.io/RelatedPersonConsent/CodeSystem/AuthorizedCodes",
      "code" : "RelatedPersonAuthorizing"
    }
  ]
}
Consent.Slices for category.category:relInfo 1..1 CodeableConcept Classification of the consent statement - for indexing/retrieval
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "64292-6"
    }
  ]
}
Consent.Slices for category.category:idscl 1..1 CodeableConcept Classification of the consent statement - for indexing/retrieval
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
      "code" : "IDSCL"
    }
  ]
}
Consent.patient 1..1 Reference(Patient) Who the consent applies to
Consent.dateTime 1..1 dateTime When this Consent was created or indexed
Consent.performer 1..* Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
Consent.organization 1..* Reference(Organization) Custodian of the consent
Consent.source[x] 0..1 Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) would point at the Consent paperwork signed by the Patient
Consent.provision 1..1 BackboneElement Constraints to the base Consent.policyRule
Consent.provision.type 1..1 code deny | permit
Required Pattern: permit (extensions allowed)
Consent.provision.actor 1..* BackboneElement Who|what controlled by this rule (or group, by role)
Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATEE"
    }
  ]
}
Consent.provision.actor.reference 1..1 Reference(RelatedPerson) Resource for the actor (or group, by role)
Consent.provision.action 0..* CodeableConcept may indicate subset of actions allowed
Consent.provision.securityLabel 0..* Coding may indicate a subset of data tags allowed
Consent.provision.purpose 0..* Coding may indicate a subset of access purposes of use allowed
Binding: Authorization purposes for delegation access valueset (required)
Consent.provision.class 0..* Coding may indicate a subset of classes of data allowed
Consent.provision.dataPeriod 0..1 Period may indicate a data period allowed
Consent.provision.data 0..* BackboneElement may indicate specific data instances allowed
Consent.provision.provision 0..* may indicate exceptions, specific rules disallowed

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Consent.provision.purpose Base required Authorization purposes for delegation access valueset 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
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
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
Consent.id This element is included in summaries. 0..1 id Logical id of this artifact
Consent.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Consent.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Consent.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Consent.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Consent.contained 0..* Resource Contained, inline Resources
Consent.extension 0..* Extension Additional content defined by implementations
Consent.identifier This element is included in summaries. 0..* Identifier Identifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
Consent.status This element is a modifier element. This element is included in summaries. 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Required Pattern: active (extensions allowed)
Consent.scope This element is a modifier element. This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/consentscope",
      "code" : "patient-privacy"
    }
  ]
}
Consent.Slices for category This element is included in summaries. 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.

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Consent.Slices for category.category:representative This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://johnmoehrke.github.io/RelatedPersonConsent/CodeSystem/AuthorizedCodes",
      "code" : "RelatedPersonAuthorizing"
    }
  ]
}
Consent.Slices for category.category:relInfo This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://loinc.org",
      "code" : "64292-6"
    }
  ]
}
Consent.Slices for category.category:idscl This element is included in summaries. 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: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-ActCode",
      "code" : "IDSCL"
    }
  ]
}
Consent.patient This element is included in summaries. 1..1 Reference(Patient) Who the consent applies to
Consent.dateTime This element is included in summaries. 1..1 dateTime When this Consent was created or indexed
Consent.performer This element is included in summaries. 1..* Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) Who is agreeing to the policy and rules
Consent.organization This element is included in summaries. 1..* Reference(Organization) Custodian of the consent
Consent.source[x] This element is included in summaries. 0..1 Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) would point at the Consent paperwork signed by the Patient
Consent.policy 0..* BackboneElement Policies covered by this consent
Consent.policy.id 0..1 string Unique id for inter-element referencing
Consent.policy.extension 0..* Extension Additional content defined by implementations
Consent.policy.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.policy.authority C 0..1 uri Enforcement source for policy
Consent.policy.uri C 0..1 uri Specific policy covered by this consent
Consent.policyRule This element is included in summaries. C 0..1 CodeableConcept Regulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
Consent.verification This element is included in summaries. 0..* BackboneElement Consent Verified by patient or family
Consent.verification.id 0..1 string Unique id for inter-element referencing
Consent.verification.extension 0..* Extension Additional content defined by implementations
Consent.verification.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.verification.verified This element is included in summaries. 1..1 boolean Has been verified
Consent.verification.verifiedWith 0..1 Reference(Patient | RelatedPerson) Person who verified
Consent.verification.verificationDate 0..1 dateTime When consent verified
Consent.provision This element is included in summaries. 1..1 BackboneElement Constraints to the base Consent.policyRule
Consent.provision.id 0..1 string Unique id for inter-element referencing
Consent.provision.extension 0..* Extension Additional content defined by implementations
Consent.provision.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.type This element is included in summaries. 1..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
Required Pattern: permit (extensions allowed)
Consent.provision.period This element is included in summaries. 0..1 Period Timeframe for this rule
Consent.provision.actor 1..* BackboneElement Who|what controlled by this rule (or group, by role)
Consent.provision.actor.id 0..1 string Unique id for inter-element referencing
Consent.provision.actor.extension 0..* Extension Additional content defined by implementations
Consent.provision.actor.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.actor.role 1..1 CodeableConcept How the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
Required Pattern: 
{
  "coding" : [
    {
      "system" : "http://terminology.hl7.org/CodeSystem/v3-RoleCode",
      "code" : "DELEGATEE"
    }
  ]
}
Consent.provision.actor.reference 1..1 Reference(RelatedPerson) Resource for the actor (or group, by role)
Consent.provision.action This element is included in summaries. 0..* CodeableConcept may indicate subset of actions allowed
Binding: ConsentActionCodes (example): Detailed codes for the consent action.
Consent.provision.securityLabel This element is included in summaries. 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.
Consent.provision.purpose This element is included in summaries. 0..* Coding may indicate a subset of access purposes of use allowed
Binding: Authorization purposes for delegation access valueset (required)
Consent.provision.class This element is included in summaries. 0..* Coding may indicate a subset of classes of data allowed
Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
Consent.provision.code This element is included in summaries. 0..* CodeableConcept e.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
Consent.provision.dataPeriod This element is included in summaries. 0..1 Period may indicate a data period allowed
Consent.provision.data This element is included in summaries. 0..* BackboneElement may indicate specific data instances allowed
Consent.provision.data.id 0..1 string Unique id for inter-element referencing
Consent.provision.data.extension 0..* Extension Additional content defined by implementations
Consent.provision.data.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Consent.provision.data.meaning This element is included in summaries. 1..1 code instance | related | dependents | authoredby
Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
Consent.provision.data.reference This element is included in summaries. 1..1 Reference(Resource) The actual data reference
Consent.provision.provision 0..* See provision (Consent) may indicate exceptions, specific rules disallowed

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Consent.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Consent.status Base required ConsentState 📍4.0.1 FHIR Std.
Consent.scope Base extensible Consent Scope Codes 📍4.0.1 FHIR Std.
Consent.category Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:representative Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:relInfo Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.category:idscl Base extensible Consent Category Codes 📍4.0.1 FHIR Std.
Consent.policyRule Base extensible Consent PolicyRule Codes 📍4.0.1 FHIR Std.
Consent.provision.type Base required ConsentProvisionType 📍4.0.1 FHIR Std.
Consent.provision.actor.​role Base extensible SecurityRoleType 📍4.0.1 FHIR Std.
Consent.provision.action Base example Consent Action Codes 📍4.0.1 FHIR Std.
Consent.provision.securityLabel Base extensible SecurityLabels 📍4.0.1 FHIR Std.
Consent.provision.purpose Base required Authorization purposes for delegation access valueset 📦0.1.0 This IG
Consent.provision.class Base extensible Consent Content Class 📍4.0.1 FHIR Std.
Consent.provision.code Base example Consent Content Codes 📍4.0.1 FHIR Std.
Consent.provision.data.​meaning Base required ConsentDataMeaning 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression

This structure is derived from Consent

Summary

Mandatory: 10 elements
Prohibited: 1 element

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Consent.category

Maturity: 1

 

Other representations of profile: CSV, Excel, Schematron