Polaris FHIR Implementation Guide - Local Development build (v1.10.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• FSH
• XML
• JSON
• TTL

Resource Profile: Polaris App Consent Profile Core

Simple app consent profile: Patient X consented/refused to share information with Application Y (represented as a Device). This profile models consent for a patient to sign up with an app.

Usages:

• Examples for this Profile: Consent/avery-research-consent-proposed, Consent/avery-wellness-consent-denied and Consent/polaris-core-app-consent-scribe-ai-example

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.

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent	C	0..*	Consent	Patient consent for app signup and data sharing Core Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, app-consent-has-polaris-id
meta	Σ	0..1	Meta	Metadata about the resource
source	SΣ	0..1	uri	Identifies EMR instance & pipeline version the resource came from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	Consent record identifier Slice: Unordered, Open by pattern:system Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
identifier:polarisId	SΣ	1..1	Identifier	Polaris App Consent ID Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
system	Σ	1..1	uri	Polaris app-consent identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-app-consent-identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual Polaris app consent ID value: unique in source system Example General: 123456
identifier:rawCode	SΣ	0..*	Identifier	Source EMR app consent identifier Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-app-consent-raw-code Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
status	?!SΣ	1..1	code	active | draft | inactive | entered-in-error Binding: ConsentState (required)
scope	?!SΣ	1..1	CodeableConcept	patient-privacy - Privacy consent Binding: ConsentScopeCodes (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
display		1..1	string	Representation defined by the system Fixed Value: Privacy Consent
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
category	SΣ	1..1	CodeableConcept	infa - Information Access Binding: ConsentCategoryCodes (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentcategorycodes
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: infa
display		1..1	string	Representation defined by the system Fixed Value: Information Access
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(Polaris Patient Core)	The patient (Patient X)
dateTime	SΣ	1..1	dateTime	When consent was given/withdrawn
Slices for source[x]	Σ	0..1		Source from which this consent is taken Slice: Unordered, Open by type:$this
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
source[x]:sourceAttachment	SΣ	0..1	Attachment	Original consent document attachment
policyRule	SΣC	1..1	CodeableConcept	cric - Common Rule Informed Consent Binding: ConsentPolicyRuleCodes (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentpolicycodes
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: cric
display		1..1	string	Representation defined by the system Fixed Value: Common Rule Informed Consent
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
provision	SΣ	1..1	BackboneElement	Consent rules for the app
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SΣ	0..1	code	NOT used in root provision per R4 spec Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
actor	S	1..1	BackboneElement	The third-party app (Application Y)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	1..1	CodeableConcept	information-recipient Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
reference	S	1..1	Reference(Polaris App Device Core)	Reference to the app Device
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.identifier:polarisId.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Consent.identifier:rawCode.use	required	Pattern Value: secondary http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes From the FHIR Standard
Consent.scope	required	Fixed Value: patient-privacy("Privacy Consent") http://hl7.org/fhir/ValueSet/consent-scope From the FHIR Standard
Consent.category	required	Fixed Value: infa("Information Access") http://hl7.org/fhir/ValueSet/consent-category From the FHIR Standard
Consent.policyRule	required	Fixed Value: cric("Common Rule Informed Consent") http://hl7.org/fhir/ValueSet/consent-policy From the FHIR Standard
Consent.provision.type	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 From the FHIR Standard
Consent.provision.actor.role	extensible	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
app-consent-has-polaris-id	error	Consent	Must have at least one identifier whose system matches the Polaris app consent identifier pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[a-zA-Z0-9._-]+-app-consent-identifier$'))
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Consent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Consent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Consent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ppc-1	error	Consent	Either a Policy or PolicyRule : policy.exists() or policyRule.exists()
ppc-2	error	Consent	IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3	error	Consent	IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4	error	Consent	IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5	error	Consent	IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

This structure is derived from Consent

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent	C	0..*	Consent	Patient consent for app signup and data sharing Core Constraints: app-consent-has-polaris-id
meta
source	S	0..1	uri	Identifies EMR instance & pipeline version the resource came from
Slices for identifier	S	1..*	Identifier	Consent record identifier Slice: Unordered, Open by pattern:system
identifier:polarisId	S	1..1	Identifier	Polaris App Consent ID
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: official
system		1..1	uri	Polaris app-consent identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-app-consent-identifier
value		1..1	string	The actual Polaris app consent ID value: unique in source system
identifier:rawCode	S	0..*	Identifier	Source EMR app consent identifier
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: secondary
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-app-consent-raw-code
value		1..1	string	The value that is unique
status	S	1..1	code	active | draft | inactive | entered-in-error Binding: ConsentState (required)
scope	S	1..1	CodeableConcept	patient-privacy - Privacy consent Binding: ConsentScopeCodes (required) Fixed Value: As shown
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
code		1..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
display		1..1	string	Representation defined by the system Fixed Value: Privacy Consent
category	S	1..1	CodeableConcept	infa - Information Access Binding: ConsentCategoryCodes (required) Fixed Value: As shown
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentcategorycodes
code		1..1	code	Symbol in syntax defined by the system Fixed Value: infa
display		1..1	string	Representation defined by the system Fixed Value: Information Access
patient	S	1..1	Reference(Polaris Patient Core)	The patient (Patient X)
dateTime	S	1..1	dateTime	When consent was given/withdrawn
Slices for source[x]		0..1	Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)	Source from which this consent is taken Slice: Unordered, Open by type:$this
source[x]:sourceAttachment	S	0..1	Attachment	Original consent document attachment
policyRule	S	1..1	CodeableConcept	cric - Common Rule Informed Consent Binding: ConsentPolicyRuleCodes (required) Fixed Value: As shown
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentpolicycodes
code		1..1	code	Symbol in syntax defined by the system Fixed Value: cric
display		1..1	string	Representation defined by the system Fixed Value: Common Rule Informed Consent
provision	S	1..1	BackboneElement	Consent rules for the app
type	S	0..1	code	NOT used in root provision per R4 spec
actor	S	1..1	BackboneElement	The third-party app (Application Y)
role	S	1..1	CodeableConcept	information-recipient
reference	S	1..1	Reference(Polaris App Device Core)	Reference to the app Device
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes From the FHIR Standard
Consent.scope	required	Fixed Value: patient-privacy("Privacy Consent") http://hl7.org/fhir/ValueSet/consent-scope From the FHIR Standard
Consent.category	required	Fixed Value: infa("Information Access") http://hl7.org/fhir/ValueSet/consent-category From the FHIR Standard
Consent.policyRule	required	Fixed Value: cric("Common Rule Informed Consent") http://hl7.org/fhir/ValueSet/consent-policy From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
app-consent-has-polaris-id	error	Consent	Must have at least one identifier whose system matches the Polaris app consent identifier pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[a-zA-Z0-9._-]+-app-consent-identifier$'))

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent	C	0..*	Consent	Patient consent for app signup and data sharing Core Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, app-consent-has-polaris-id
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	SΣ	0..1	uri	Identifies EMR instance & pipeline version the resource came from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	Consent record identifier Slice: Unordered, Open by pattern:system Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
identifier:polarisId	SΣ	1..1	Identifier	Polaris App Consent ID Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	Polaris app-consent identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-app-consent-identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual Polaris app consent ID value: unique in source system Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:rawCode	SΣ	0..*	Identifier	Source EMR app consent identifier Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-app-consent-raw-code Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	active | draft | inactive | entered-in-error Binding: ConsentState (required)
scope	?!SΣ	1..1	CodeableConcept	patient-privacy - Privacy consent Binding: ConsentScopeCodes (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
display		1..1	string	Representation defined by the system Fixed Value: Privacy Consent
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
category	SΣ	1..1	CodeableConcept	infa - Information Access Binding: ConsentCategoryCodes (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentcategorycodes
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: infa
display		1..1	string	Representation defined by the system Fixed Value: Information Access
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(Polaris Patient Core)	The patient (Patient X)
dateTime	SΣ	1..1	dateTime	When consent was given/withdrawn
performer	Σ	0..*	Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Who is agreeing to the policy and rules
organization	Σ	0..*	Reference(Organization)	Custodian of the consent
Slices for source[x]	Σ	0..1		Source from which this consent is taken Slice: Unordered, Open by type:$this
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
source[x]:sourceAttachment	SΣ	0..1	Attachment	Original consent document attachment
policy		0..*	BackboneElement	Policies covered by this consent
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
authority	C	0..1	uri	Enforcement source for policy
uri	C	0..1	uri	Specific policy covered by this consent
policyRule	SΣC	1..1	CodeableConcept	cric - Common Rule Informed Consent Binding: ConsentPolicyRuleCodes (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentpolicycodes
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: cric
display		1..1	string	Representation defined by the system Fixed Value: Common Rule Informed Consent
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
verification	Σ	0..*	BackboneElement	Consent Verified by patient or family
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
verified	Σ	1..1	boolean	Has been verified
verifiedWith		0..1	Reference(Patient | RelatedPerson)	Person who verified
verificationDate		0..1	dateTime	When consent verified
provision	SΣ	1..1	BackboneElement	Consent rules for the app
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SΣ	0..1	code	NOT used in root provision per R4 spec Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
period	Σ	0..1	Period	Timeframe for this rule
actor	S	1..1	BackboneElement	The third-party app (Application Y)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	1..1	CodeableConcept	information-recipient Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
reference	S	1..1	Reference(Polaris App Device Core)	Reference to the app Device
action	Σ	0..*	CodeableConcept	Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
securityLabel	Σ	0..*	Coding	Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
purpose	Σ	0..*	Coding	Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
class	Σ	0..*	Coding	e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
code	Σ	0..*	CodeableConcept	e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
dataPeriod	Σ	0..1	Period	Timeframe for data controlled by this rule
data	Σ	0..*	BackboneElement	Data controlled by this rule
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
reference	Σ	1..1	Reference(Resource)	The actual data reference
provision		0..*	See provision (Consent)	Nested Exception Rules
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Consent.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Consent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Consent.identifier:polarisId.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Consent.identifier:polarisId.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.identifier:rawCode.use	required	Pattern Value: secondary http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Consent.identifier:rawCode.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes From the FHIR Standard
Consent.scope	required	Fixed Value: patient-privacy("Privacy Consent") http://hl7.org/fhir/ValueSet/consent-scope From the FHIR Standard
Consent.category	required	Fixed Value: infa("Information Access") http://hl7.org/fhir/ValueSet/consent-category From the FHIR Standard
Consent.policyRule	required	Fixed Value: cric("Common Rule Informed Consent") http://hl7.org/fhir/ValueSet/consent-policy From the FHIR Standard
Consent.provision.type	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 From the FHIR Standard
Consent.provision.actor.role	extensible	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard
Consent.provision.action	example	ConsentActionCodes http://hl7.org/fhir/ValueSet/consent-action From the FHIR Standard
Consent.provision.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Consent.provision.purpose	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.class	extensible	ConsentContentClass http://hl7.org/fhir/ValueSet/consent-content-class From the FHIR Standard
Consent.provision.code	example	ConsentContentCodes(a valid code from LOINC) http://hl7.org/fhir/ValueSet/consent-content-code From the FHIR Standard
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
app-consent-has-polaris-id	error	Consent	Must have at least one identifier whose system matches the Polaris app consent identifier pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[a-zA-Z0-9._-]+-app-consent-identifier$'))
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Consent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Consent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Consent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ppc-1	error	Consent	Either a Policy or PolicyRule : policy.exists() or policyRule.exists()
ppc-2	error	Consent	IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3	error	Consent	IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4	error	Consent	IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5	error	Consent	IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

This structure is derived from Consent

Summary

Mandatory: 9 elements(2 nested mandatory elements)
Must-Support: 16 elements
Fixed: 3 elements

Structures

This structure refers to these other structures:

• Polaris Patient Core (https://fhir.apps.health/StructureDefinition/polaris-core-patient)
• Polaris App Device Core (https://fhir.apps.health/StructureDefinition/polaris-core-appdevice)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Consent.identifier
• The element 1 is sliced based on the value of Consent.source[x]

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent	C	0..*	Consent	Patient consent for app signup and data sharing Core Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, app-consent-has-polaris-id
meta	Σ	0..1	Meta	Metadata about the resource
source	SΣ	0..1	uri	Identifies EMR instance & pipeline version the resource came from
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	Consent record identifier Slice: Unordered, Open by pattern:system Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
identifier:polarisId	SΣ	1..1	Identifier	Polaris App Consent ID Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
system	Σ	1..1	uri	Polaris app-consent identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-app-consent-identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual Polaris app consent ID value: unique in source system Example General: 123456
identifier:rawCode	SΣ	0..*	Identifier	Source EMR app consent identifier Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-app-consent-raw-code Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
status	?!SΣ	1..1	code	active | draft | inactive | entered-in-error Binding: ConsentState (required)
scope	?!SΣ	1..1	CodeableConcept	patient-privacy - Privacy consent Binding: ConsentScopeCodes (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
display		1..1	string	Representation defined by the system Fixed Value: Privacy Consent
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
category	SΣ	1..1	CodeableConcept	infa - Information Access Binding: ConsentCategoryCodes (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentcategorycodes
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: infa
display		1..1	string	Representation defined by the system Fixed Value: Information Access
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(Polaris Patient Core)	The patient (Patient X)
dateTime	SΣ	1..1	dateTime	When consent was given/withdrawn
Slices for source[x]	Σ	0..1		Source from which this consent is taken Slice: Unordered, Open by type:$this
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
source[x]:sourceAttachment	SΣ	0..1	Attachment	Original consent document attachment
policyRule	SΣC	1..1	CodeableConcept	cric - Common Rule Informed Consent Binding: ConsentPolicyRuleCodes (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentpolicycodes
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: cric
display		1..1	string	Representation defined by the system Fixed Value: Common Rule Informed Consent
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
provision	SΣ	1..1	BackboneElement	Consent rules for the app
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SΣ	0..1	code	NOT used in root provision per R4 spec Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
actor	S	1..1	BackboneElement	The third-party app (Application Y)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	1..1	CodeableConcept	information-recipient Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
reference	S	1..1	Reference(Polaris App Device Core)	Reference to the app Device
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.identifier:polarisId.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Consent.identifier:rawCode.use	required	Pattern Value: secondary http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes From the FHIR Standard
Consent.scope	required	Fixed Value: patient-privacy("Privacy Consent") http://hl7.org/fhir/ValueSet/consent-scope From the FHIR Standard
Consent.category	required	Fixed Value: infa("Information Access") http://hl7.org/fhir/ValueSet/consent-category From the FHIR Standard
Consent.policyRule	required	Fixed Value: cric("Common Rule Informed Consent") http://hl7.org/fhir/ValueSet/consent-policy From the FHIR Standard
Consent.provision.type	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 From the FHIR Standard
Consent.provision.actor.role	extensible	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
app-consent-has-polaris-id	error	Consent	Must have at least one identifier whose system matches the Polaris app consent identifier pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[a-zA-Z0-9._-]+-app-consent-identifier$'))
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Consent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Consent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Consent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ppc-1	error	Consent	Either a Policy or PolicyRule : policy.exists() or policyRule.exists()
ppc-2	error	Consent	IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3	error	Consent	IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4	error	Consent	IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5	error	Consent	IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

Differential View

This structure is derived from Consent

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent	C	0..*	Consent	Patient consent for app signup and data sharing Core Constraints: app-consent-has-polaris-id
meta
source	S	0..1	uri	Identifies EMR instance & pipeline version the resource came from
Slices for identifier	S	1..*	Identifier	Consent record identifier Slice: Unordered, Open by pattern:system
identifier:polarisId	S	1..1	Identifier	Polaris App Consent ID
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: official
system		1..1	uri	Polaris app-consent identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-app-consent-identifier
value		1..1	string	The actual Polaris app consent ID value: unique in source system
identifier:rawCode	S	0..*	Identifier	Source EMR app consent identifier
use		0..1	code	usual | official | temp | secondary | old (If known) Required Pattern: secondary
system		1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-app-consent-raw-code
value		1..1	string	The value that is unique
status	S	1..1	code	active | draft | inactive | entered-in-error Binding: ConsentState (required)
scope	S	1..1	CodeableConcept	patient-privacy - Privacy consent Binding: ConsentScopeCodes (required) Fixed Value: As shown
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
code		1..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
display		1..1	string	Representation defined by the system Fixed Value: Privacy Consent
category	S	1..1	CodeableConcept	infa - Information Access Binding: ConsentCategoryCodes (required) Fixed Value: As shown
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentcategorycodes
code		1..1	code	Symbol in syntax defined by the system Fixed Value: infa
display		1..1	string	Representation defined by the system Fixed Value: Information Access
patient	S	1..1	Reference(Polaris Patient Core)	The patient (Patient X)
dateTime	S	1..1	dateTime	When consent was given/withdrawn
Slices for source[x]		0..1	Attachment, Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)	Source from which this consent is taken Slice: Unordered, Open by type:$this
source[x]:sourceAttachment	S	0..1	Attachment	Original consent document attachment
policyRule	S	1..1	CodeableConcept	cric - Common Rule Informed Consent Binding: ConsentPolicyRuleCodes (required) Fixed Value: As shown
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentpolicycodes
code		1..1	code	Symbol in syntax defined by the system Fixed Value: cric
display		1..1	string	Representation defined by the system Fixed Value: Common Rule Informed Consent
provision	S	1..1	BackboneElement	Consent rules for the app
type	S	0..1	code	NOT used in root provision per R4 spec
actor	S	1..1	BackboneElement	The third-party app (Application Y)
role	S	1..1	CodeableConcept	information-recipient
reference	S	1..1	Reference(Polaris App Device Core)	Reference to the app Device
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet / Code	URI
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes From the FHIR Standard
Consent.scope	required	Fixed Value: patient-privacy("Privacy Consent") http://hl7.org/fhir/ValueSet/consent-scope From the FHIR Standard
Consent.category	required	Fixed Value: infa("Information Access") http://hl7.org/fhir/ValueSet/consent-category From the FHIR Standard
Consent.policyRule	required	Fixed Value: cric("Common Rule Informed Consent") http://hl7.org/fhir/ValueSet/consent-policy From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
app-consent-has-polaris-id	error	Consent	Must have at least one identifier whose system matches the Polaris app consent identifier pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[a-zA-Z0-9._-]+-app-consent-identifier$'))

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent	C	0..*	Consent	Patient consent for app signup and data sharing Core Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5, app-consent-has-polaris-id
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
source	SΣ	0..1	uri	Identifies EMR instance & pipeline version the resource came from
profile	Σ	0..*	canonical(StructureDefinition)	Profiles this resource claims to conform to
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	Σ	0..*	Coding	Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
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
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
Slices for identifier	SΣ	1..*	Identifier	Consent record identifier Slice: Unordered, Open by pattern:system Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
identifier:polarisId	SΣ	1..1	Identifier	Polaris App Consent ID Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: official
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	Polaris app-consent identifier system: https://fhir.apps.health/NamingSystem/<instance-id>-app-consent-identifier Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The actual Polaris app consent ID value: unique in source system Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
identifier:rawCode	SΣ	0..*	Identifier	Source EMR app consent identifier Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . Required Pattern: secondary
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	Source system URI or https://fhir.apps.health/NamingSystem/<instance-id>-app-consent-raw-code Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	Organization that issued id (may be just text)
status	?!SΣ	1..1	code	active | draft | inactive | entered-in-error Binding: ConsentState (required)
scope	?!SΣ	1..1	CodeableConcept	patient-privacy - Privacy consent Binding: ConsentScopeCodes (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
display		1..1	string	Representation defined by the system Fixed Value: Privacy Consent
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
category	SΣ	1..1	CodeableConcept	infa - Information Access Binding: ConsentCategoryCodes (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentcategorycodes
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: infa
display		1..1	string	Representation defined by the system Fixed Value: Information Access
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
patient	SΣ	1..1	Reference(Polaris Patient Core)	The patient (Patient X)
dateTime	SΣ	1..1	dateTime	When consent was given/withdrawn
performer	Σ	0..*	Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Who is agreeing to the policy and rules
organization	Σ	0..*	Reference(Organization)	Custodian of the consent
Slices for source[x]	Σ	0..1		Source from which this consent is taken Slice: Unordered, Open by type:$this
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
source[x]:sourceAttachment	SΣ	0..1	Attachment	Original consent document attachment
policy		0..*	BackboneElement	Policies covered by this consent
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
authority	C	0..1	uri	Enforcement source for policy
uri	C	0..1	uri	Specific policy covered by this consent
policyRule	SΣC	1..1	CodeableConcept	cric - Common Rule Informed Consent Binding: ConsentPolicyRuleCodes (required) Fixed Value: As shown
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
coding		1..1	Coding	Code defined by a terminology system Fixed Value: (Complex)
id		0..0	string	Unique id for inter-element referencing
extension		0..0	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentpolicycodes
version		0..0	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: cric
display		1..1	string	Representation defined by the system Fixed Value: Common Rule Informed Consent
userSelected		0..0	boolean	If this coding was chosen directly by the user
text		0..0	string	Plain text representation of the concept
verification	Σ	0..*	BackboneElement	Consent Verified by patient or family
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
verified	Σ	1..1	boolean	Has been verified
verifiedWith		0..1	Reference(Patient | RelatedPerson)	Person who verified
verificationDate		0..1	dateTime	When consent verified
provision	SΣ	1..1	BackboneElement	Consent rules for the app
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	SΣ	0..1	code	NOT used in root provision per R4 spec Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
period	Σ	0..1	Period	Timeframe for this rule
actor	S	1..1	BackboneElement	The third-party app (Application Y)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	1..1	CodeableConcept	information-recipient Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
reference	S	1..1	Reference(Polaris App Device Core)	Reference to the app Device
action	Σ	0..*	CodeableConcept	Actions controlled by this rule Binding: ConsentActionCodes (example): Detailed codes for the consent action.
securityLabel	Σ	0..*	Coding	Security Labels that define affected resources Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
purpose	Σ	0..*	Coding	Context of activities covered by this rule Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
class	Σ	0..*	Coding	e.g. Resource Type, Profile, CDA, etc. Binding: ConsentContentClass (extensible): The class (type) of information a consent rule covers.
code	Σ	0..*	CodeableConcept	e.g. LOINC or SNOMED CT code, etc. in the content Binding: ConsentContentCodes (example): If this code is found in an instance, then the exception applies.
dataPeriod	Σ	0..1	Period	Timeframe for data controlled by this rule
data	Σ	0..*	BackboneElement	Data controlled by this rule
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions.
reference	Σ	1..1	Reference(Resource)	The actual data reference
provision		0..*	See provision (Consent)	Nested Exception Rules
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.meta.security	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Consent.meta.tag	example	CommonTags http://hl7.org/fhir/ValueSet/common-tags From the FHIR Standard
Consent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Consent.identifier:polarisId.use	required	Pattern Value: official http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Consent.identifier:polarisId.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.identifier:rawCode.use	required	Pattern Value: secondary http://hl7.org/fhir/ValueSet/identifier-use|4.0.1 From the FHIR Standard
Consent.identifier:rawCode.type	extensible	Identifier Type Codes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes From the FHIR Standard
Consent.scope	required	Fixed Value: patient-privacy("Privacy Consent") http://hl7.org/fhir/ValueSet/consent-scope From the FHIR Standard
Consent.category	required	Fixed Value: infa("Information Access") http://hl7.org/fhir/ValueSet/consent-category From the FHIR Standard
Consent.policyRule	required	Fixed Value: cric("Common Rule Informed Consent") http://hl7.org/fhir/ValueSet/consent-policy From the FHIR Standard
Consent.provision.type	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 From the FHIR Standard
Consent.provision.actor.role	extensible	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type From the FHIR Standard
Consent.provision.action	example	ConsentActionCodes http://hl7.org/fhir/ValueSet/consent-action From the FHIR Standard
Consent.provision.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard
Consent.provision.purpose	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.class	extensible	ConsentContentClass http://hl7.org/fhir/ValueSet/consent-content-class From the FHIR Standard
Consent.provision.code	example	ConsentContentCodes(a valid code from LOINC) http://hl7.org/fhir/ValueSet/consent-content-code From the FHIR Standard
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
app-consent-has-polaris-id	error	Consent	Must have at least one identifier whose system matches the Polaris app consent identifier pattern. : identifier.exists(system.matches('^https://fhir.apps.health/NamingSystem/[a-zA-Z0-9._-]+-app-consent-identifier$'))
dom-2	error	Consent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	Consent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4	error	Consent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	Consent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	Consent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ppc-1	error	Consent	Either a Policy or PolicyRule : policy.exists() or policyRule.exists()
ppc-2	error	Consent	IF Scope=privacy, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3	error	Consent	IF Scope=research, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4	error	Consent	IF Scope=adr, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5	error	Consent	IF Scope=treatment, there must be a patient : patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()

This structure is derived from Consent

Summary

Mandatory: 9 elements(2 nested mandatory elements)
Must-Support: 16 elements
Fixed: 3 elements

Structures

This structure refers to these other structures:

• Polaris Patient Core (https://fhir.apps.health/StructureDefinition/polaris-core-patient)
• Polaris App Device Core (https://fhir.apps.health/StructureDefinition/polaris-core-appdevice)

Slices

This structure defines the following Slices:

• The element 1 is sliced based on the value of Consent.identifier
• The element 1 is sliced based on the value of Consent.source[x]