HL7.FHIR.US.SDOHCC\SDOHCC_Consent_FoodInsecurity_1

SDOH Clinical Care
0.0.4C3 - CI Build

SDOH Clinical Care - Local Development build (v0.0.4C3). See the Directory of published versions

Resource Profile: SDOHCC_Consent_FoodInsecurity_1

The official URL for this profile is:

http://hl7.org/fhir/us/sdoh-cc/StructureDefinition/SDOHCC-Consent-FoodInsecurity-1

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
All

This structure is derived from Consent

Summary

Mandatory: 5 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient

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
status	S	1..1	code	draft \| proposed \| active \| rejected \| inactive \| entered-in-error
scope	S	1..1	CodeableConcept	Which of the four areas this resource covers (extensible)
category	S	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval
patient	S	1..1	Reference(US Core Patient Profile)	Who the consent applies to
dateTime	S	1..1	dateTime	When this Consent was created or indexed
performer	S	1..1	Reference(US Core Patient Profile)	Who is agreeing to the policy and rules
organization	S	1..1	Reference(OrganizationAffiliation)	Custodian of the consent
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Consent	I	0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
identifier	ΣI	0..*	Identifier	Identifier for this record (external references) Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
status	?!SΣI	1..1	code	draft \| proposed \| active \| rejected \| inactive \| entered-in-error Binding: ConsentState (required)
scope	?!SΣI	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible)
category	SΣI	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible)
patient	SΣI	1..1	Reference(US Core Patient Profile)	Who the consent applies to
dateTime	SΣI	1..1	dateTime	When this Consent was created or indexed
performer	SΣI	1..1	Reference(US Core Patient Profile)	Who is agreeing to the policy and rules
organization	SΣI	1..1	Reference(OrganizationAffiliation)	Custodian of the consent
source[x]	ΣI	0..1		Source from which this consent is taken
sourceAttachment			Attachment
sourceReference			Reference(Consent \| DocumentReference \| Contract \| QuestionnaireResponse)
policy	I	0..*	BackboneElement	Policies covered by this consent
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
authority	I	0..1	uri	Enforcement source for policy
uri	I	0..1	uri	Specific policy covered by this consent
policyRule	ΣI	0..1	CodeableConcept	Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible)
verification	ΣI	0..*	BackboneElement	Consent Verified by patient or family
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
verified	ΣI	1..1	boolean	Has been verified
verifiedWith	I	0..1	Reference(Patient \| RelatedPerson)	Person who verified
verificationDate	I	0..1	dateTime	When consent verified
provision	ΣI	0..1	BackboneElement	Constraints to the base Consent.policyRule
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	ΣI	0..1	code	deny \| permit Binding: ConsentProvisionType (required)
period	ΣI	0..1	Period	Timeframe for this rule
actor	I	0..*	BackboneElement	Who\|what controlled by this rule (or group, by role)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	I	1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible)
reference	I	1..1	Reference(Device \| Group \| CareTeam \| Organization \| Patient \| Practitioner \| RelatedPerson \| PractitionerRole)	Resource for the actor (or group, by role)
action	ΣI	0..*	CodeableConcept	Actions controlled by this rule Binding: ConsentActionCodes (example)
securityLabel	ΣI	0..*	Coding	Security Labels that define affected resources Binding: All Security Labels (extensible)
purpose	ΣI	0..*	Coding	Context of activities covered by this rule Binding: V3 Value SetPurposeOfUse (extensible)
class	ΣI	0..*	Coding	e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible)
code	ΣI	0..*	CodeableConcept	e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example)
dataPeriod	ΣI	0..1	Period	Timeframe for data controlled by this rule
data	ΣI	0..*	BackboneElement	Data controlled by this rule
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
meaning	ΣI	1..1	code	instance \| related \| dependents \| authoredby Binding: ConsentDataMeaning (required)
reference	ΣI	1..1	Reference(Resource)	The actual data reference
provision	I	0..*		See Consent.provision Nested Exception Rules
Documentation for this format

This structure is derived from Consent

Summary

Mandatory: 5 elements
Must-Support: 7 elements

Structures

This structure refers to these other structures:

http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient

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
status	S	1..1	code	draft \| proposed \| active \| rejected \| inactive \| entered-in-error
scope	S	1..1	CodeableConcept	Which of the four areas this resource covers (extensible)
category	S	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval
patient	S	1..1	Reference(US Core Patient Profile)	Who the consent applies to
dateTime	S	1..1	dateTime	When this Consent was created or indexed
performer	S	1..1	Reference(US Core Patient Profile)	Who is agreeing to the policy and rules
organization	S	1..1	Reference(OrganizationAffiliation)	Custodian of the consent
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Consent	I	0..*	Consent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
id	Σ	0..1	string	Logical id of this artifact
meta	ΣI	0..1	Meta	Metadata about the resource
implicitRules	?!ΣI	0..1	uri	A set of rules under which this content was created
language	I	0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!I	0..*	Extension	Extensions that cannot be ignored
identifier	ΣI	0..*	Identifier	Identifier for this record (external references) Example General: {"system":"urn:ietf:rfc:3986","value":"Local eCMS identifier"}
status	?!SΣI	1..1	code	draft \| proposed \| active \| rejected \| inactive \| entered-in-error Binding: ConsentState (required)
scope	?!SΣI	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible)
category	SΣI	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible)
patient	SΣI	1..1	Reference(US Core Patient Profile)	Who the consent applies to
dateTime	SΣI	1..1	dateTime	When this Consent was created or indexed
performer	SΣI	1..1	Reference(US Core Patient Profile)	Who is agreeing to the policy and rules
organization	SΣI	1..1	Reference(OrganizationAffiliation)	Custodian of the consent
source[x]	ΣI	0..1		Source from which this consent is taken
sourceAttachment			Attachment
sourceReference			Reference(Consent \| DocumentReference \| Contract \| QuestionnaireResponse)
policy	I	0..*	BackboneElement	Policies covered by this consent
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
authority	I	0..1	uri	Enforcement source for policy
uri	I	0..1	uri	Specific policy covered by this consent
policyRule	ΣI	0..1	CodeableConcept	Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible)
verification	ΣI	0..*	BackboneElement	Consent Verified by patient or family
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
verified	ΣI	1..1	boolean	Has been verified
verifiedWith	I	0..1	Reference(Patient \| RelatedPerson)	Person who verified
verificationDate	I	0..1	dateTime	When consent verified
provision	ΣI	0..1	BackboneElement	Constraints to the base Consent.policyRule
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	ΣI	0..1	code	deny \| permit Binding: ConsentProvisionType (required)
period	ΣI	0..1	Period	Timeframe for this rule
actor	I	0..*	BackboneElement	Who\|what controlled by this rule (or group, by role)
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	I	1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible)
reference	I	1..1	Reference(Device \| Group \| CareTeam \| Organization \| Patient \| Practitioner \| RelatedPerson \| PractitionerRole)	Resource for the actor (or group, by role)
action	ΣI	0..*	CodeableConcept	Actions controlled by this rule Binding: ConsentActionCodes (example)
securityLabel	ΣI	0..*	Coding	Security Labels that define affected resources Binding: All Security Labels (extensible)
purpose	ΣI	0..*	Coding	Context of activities covered by this rule Binding: V3 Value SetPurposeOfUse (extensible)
class	ΣI	0..*	Coding	e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible)
code	ΣI	0..*	CodeableConcept	e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example)
dataPeriod	ΣI	0..1	Period	Timeframe for data controlled by this rule
data	ΣI	0..*	BackboneElement	Data controlled by this rule
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations
modifierExtension	?!ΣI	0..*	Extension	Extensions that cannot be ignored even if unrecognized
meaning	ΣI	1..1	code	instance \| related \| dependents \| authoredby Binding: ConsentDataMeaning (required)
reference	ΣI	1..1	Reference(Resource)	The actual data reference
provision	I	0..*		See Consent.provision Nested Exception Rules
Documentation for this format

Other representations of profile: Schematron

Terminology Bindings

Path	Conformance	ValueSet
Consent.language	preferred	CommonLanguages Max Binding: AllLanguages
Consent.status	required	ConsentState
Consent.scope	extensible	ConsentScopeCodes
Consent.category	extensible	ConsentCategoryCodes
Consent.policyRule	extensible	ConsentPolicyRuleCodes
Consent.provision.type	required	ConsentProvisionType
Consent.provision.actor.role	extensible	SecurityRoleType
Consent.provision.action	example	ConsentActionCodes
Consent.provision.securityLabel	extensible	All Security Labels
Consent.provision.purpose	extensible	v3.PurposeOfUse
Consent.provision.class	extensible	ConsentContentClass
Consent.provision.code	example	ConsentContentCodes
Consent.provision.data.meaning	required	ConsentDataMeaning

Constraints

Id	Path	Details	Requirements
dom-2	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	Consent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference \| %resource.descendants().as(canonical) \| %resource.descendants().as(uri) \| %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	Consent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	Consent	A resource should have narrative for robust management : text.`div`.exists()
ppc-1	Consent	Either a Policy or PolicyRule : policy.exists() or policyRule.exists()
ppc-2	Consent	IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3	Consent	IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4	Consent	IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5	Consent	IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()
ele-1	Consent.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.text	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Consent.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Consent.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Consent.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Consent.identifier	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.status	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.scope	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.category	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.patient	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.dateTime	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.performer	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.organization	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.source[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.policy	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.policy.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Consent.policy.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Consent.policy.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Consent.policy.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Consent.policy.authority	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.policy.uri	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.policyRule	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.verification	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.verification.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Consent.verification.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Consent.verification.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Consent.verification.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Consent.verification.verified	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.verification.verifiedWith	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.verification.verificationDate	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Consent.provision.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Consent.provision.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Consent.provision.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Consent.provision.type	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.period	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.actor	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.actor.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Consent.provision.actor.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Consent.provision.actor.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Consent.provision.actor.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Consent.provision.actor.role	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.actor.reference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.action	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.securityLabel	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.purpose	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.class	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.code	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.dataPeriod	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.data	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.data.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Consent.provision.data.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Consent.provision.data.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Consent.provision.data.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Consent.provision.data.meaning	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.data.reference	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Consent.provision.provision	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())

IG © 2020+ HL7 International - Patient Care WG. Package hl7.fhir.us.sdohcc#0.0.4C3 based on FHIR 4.0.1. Generated 2020-06-02
Links: Table of Contents | QA Report | Version History external | | Propose a change