BSeR: Bidirectional Services_eReferral

This page is part of the Bidirectional Services eReferrals (BSeR) (v1.0.0: STU 1) based on FHIR R4. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

StructureDefinition: BSeR_PatientConsent

A record regarding the consent status of the patient with regard to treatment authorization or protected health information sharing.

The official URL for this profile is:

http://hl7.org/fhir/us/bser/StructureDefinition/BSeR-PatientConsent

Formal Views of Profile Content

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

This structure is derived from Consent

Summary

Mandatory: 8 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent I0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifier for this record (external references)

Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!ΣI1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required)
... scope ?!ΣI1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible)
... category ΣI1..1CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible)
... patient ΣI1..1Reference(US Core Patient Profile)Who the consent applies to
... dateTime ΣI1..1dateTimeWhen this Consent was created or indexed
... performer ΣI1..1Reference(RelatedPerson)Who is agreeing to the policy and rules
... organization ΣI0..*Reference(Organization)Custodian of the consent
... source[x] ΣI0..1Source from which this consent is taken
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy I0..*BackboneElementPolicies covered by this consent
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... authority I0..1uriEnforcement source for policy
.... uri I0..1uriSpecific policy covered by this consent
... policyRule ΣI0..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible)
... verification ΣI0..*BackboneElementConsent Verified by patient or family
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... verified ΣI1..1booleanHas been verified
.... verifiedWith I0..1Reference(Patient | RelatedPerson)Person who verified
.... verificationDate I0..1dateTimeWhen consent verified
... provision ΣI1..1BackboneElementConstraints to the base Consent.policyRule
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type ΣI1..1codedeny | permit
Binding: ConsentProvisionType (required)
.... period ΣI0..1PeriodTimeframe for this rule
.... actor I0..*BackboneElementWho|what controlled by this rule (or group, by role)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role I1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible)
..... reference I1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
.... action ΣI0..*CodeableConceptActions controlled by this rule
Binding: ConsentActionCodes (example)
.... securityLabel ΣI0..*CodingSecurity Labels that define affected resources
Binding: All Security Labels (extensible)
.... purpose ΣI0..*CodingContext of activities covered by this rule
Binding: V3 Value SetPurposeOfUse (extensible)
.... class ΣI0..*Codinge.g. Resource Type, Profile, CDA, etc.
Binding: ConsentContentClass (extensible)
.... code ΣI0..*CodeableConcepte.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example)
.... dataPeriod ΣI0..1PeriodTimeframe for data controlled by this rule
.... data ΣI0..*BackboneElementData controlled by this rule
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... meaning ΣI1..1codeinstance | related | dependents | authoredby
Binding: ConsentDataMeaning (required)
..... reference ΣI1..1Reference(Resource)The actual data reference
.... provision I0..*Unknown reference to #Consent.provision
Nested Exception Rules

doco Documentation for this format

This structure is derived from Consent

Summary

Mandatory: 8 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent I0..*ConsentA healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifier for this record (external references)

Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
... status ?!ΣI1..1codedraft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required)
... scope ?!ΣI1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible)
... category ΣI1..1CodeableConceptClassification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible)
... patient ΣI1..1Reference(US Core Patient Profile)Who the consent applies to
... dateTime ΣI1..1dateTimeWhen this Consent was created or indexed
... performer ΣI1..1Reference(RelatedPerson)Who is agreeing to the policy and rules
... organization ΣI0..*Reference(Organization)Custodian of the consent
... source[x] ΣI0..1Source from which this consent is taken
.... sourceAttachmentAttachment
.... sourceReferenceReference(Consent | DocumentReference | Contract | QuestionnaireResponse)
... policy I0..*BackboneElementPolicies covered by this consent
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... authority I0..1uriEnforcement source for policy
.... uri I0..1uriSpecific policy covered by this consent
... policyRule ΣI0..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible)
... verification ΣI0..*BackboneElementConsent Verified by patient or family
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... verified ΣI1..1booleanHas been verified
.... verifiedWith I0..1Reference(Patient | RelatedPerson)Person who verified
.... verificationDate I0..1dateTimeWhen consent verified
... provision ΣI1..1BackboneElementConstraints to the base Consent.policyRule
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type ΣI1..1codedeny | permit
Binding: ConsentProvisionType (required)
.... period ΣI0..1PeriodTimeframe for this rule
.... actor I0..*BackboneElementWho|what controlled by this rule (or group, by role)
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role I1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible)
..... reference I1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)Resource for the actor (or group, by role)
.... action ΣI0..*CodeableConceptActions controlled by this rule
Binding: ConsentActionCodes (example)
.... securityLabel ΣI0..*CodingSecurity Labels that define affected resources
Binding: All Security Labels (extensible)
.... purpose ΣI0..*CodingContext of activities covered by this rule
Binding: V3 Value SetPurposeOfUse (extensible)
.... class ΣI0..*Codinge.g. Resource Type, Profile, CDA, etc.
Binding: ConsentContentClass (extensible)
.... code ΣI0..*CodeableConcepte.g. LOINC or SNOMED CT code, etc. in the content
Binding: ConsentContentCodes (example)
.... dataPeriod ΣI0..1PeriodTimeframe for data controlled by this rule
.... data ΣI0..*BackboneElementData controlled by this rule
..... id 0..1stringUnique id for inter-element referencing
..... extension I0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... meaning ΣI1..1codeinstance | related | dependents | authoredby
Binding: ConsentDataMeaning (required)
..... reference ΣI1..1Reference(Resource)The actual data reference
.... provision I0..*Unknown reference to #Consent.provision
Nested Exception Rules

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Consent.languagepreferredCommonLanguages
Max Binding: AllLanguages
Consent.statusrequiredConsentState
Consent.scopeextensibleConsentScopeCodes
Consent.categoryextensibleConsentCategoryCodes
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.typerequiredConsentProvisionType
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actionexampleConsentActionCodes
Consent.provision.securityLabelextensibleAll Security Labels
Consent.provision.purposeextensiblev3.PurposeOfUse
Consent.provision.classextensibleConsentContentClass
Consent.provision.codeexampleConsentContentCodes
Consent.provision.data.meaningrequiredConsentDataMeaning

Constraints

Constraints

IdPathDetailsRequirements
dom-2ConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3ConsentIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4ConsentIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5ConsentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6ConsentA resource should have narrative for robust management
: text.`div`.exists()
ppc-1ConsentEither a Policy or PolicyRule
: policy.exists() or policyRule.exists()
ppc-2ConsentIF Scope=privacy, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3ConsentIF Scope=research, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4ConsentIF Scope=adr, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5ConsentIF Scope=treatment, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()
ele-1Consent.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.textAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.statusAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.scopeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.categoryAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.dateTimeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.performerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.organizationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.source[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.policyAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.policy.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.policy.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.policy.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.policy.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.policy.authorityAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.policy.uriAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.policyRuleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.verificationAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.verification.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.verification.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.verification.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.verification.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.verification.verifiedAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.verification.verifiedWithAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.verification.verificationDateAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provisionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.provision.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.provision.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.provision.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.provision.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.actorAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.actor.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.provision.actor.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.provision.actor.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.provision.actor.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.provision.actor.roleAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.actor.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.actionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.securityLabelAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.purposeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.classAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.codeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.dataPeriodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.dataAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.data.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.provision.data.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.provision.data.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Consent.provision.data.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Consent.provision.data.meaningAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.data.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Consent.provision.provisionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())