SMART Verifiable IPS for Pilgrimage, published by WHO. This guide is not an authorized publication; it is the continuous build for version 2.0.3 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-ips-pilgrimage/tree/main and changes regularly. See the Directory of published versions

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

Resource Profile: HajjConsent

A profile of the consent resource to track consent of a pilgrim to participate

FHIR R5 upgrade notes (need this implemented as a structure map):

• make cardinality of decision 1.. and should stop using it in lieu of verification.verified
• use verification.verifiedBy instead of Consent.organization
• the period extenion should be replaced by Consent.period
• the Consent.patient should be replaced by Consent.subject
• Consent.verification.verifiedBy should be used instead of Consent.organization

Usage:

• Use this Resource Profile: Bundle - IPS for Hajj
• Examples for this Resource Profile: Consent/c7781f44-6df8-4a8b-9e06-0b34263a47c6

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
Consent	C	0..*	IntermediateConsent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. ele-1: All FHIR elements must have a @value or children
scope	?!Σ	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
code		1..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
category	Σ	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. ele-1: All FHIR elements must have a @value or children
patient	Σ	1..1	Reference(Patient)	Who the consent applies to ele-1: All FHIR elements must have a @value or children
dateTime	Σ	1..1	dateTime	When this Consent was created or indexed ele-1: All FHIR elements must have a @value or children
performer	Σ	1..*	Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Who is agreeing to the policy and rules ele-1: All FHIR elements must have a @value or children
organization	Σ	1..*	Reference(HajjOrganization)	Custodian of the consent ele-1: All FHIR elements must have a @value or children
source[x]	Σ	1..1		Source from which this consent is taken ele-1: All FHIR elements must have a @value or children
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
provision	SΣ	1..1	BackboneElement	Constraints to the base Consent.policyRule ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	Σ	1..1	code	deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. ele-1: All FHIR elements must have a @value or children
period	SΣ	1..1	Period	Timeframe for this rule ele-1: All FHIR elements must have a @value or children
actor	S	0..*	BackboneElement	Who|what controlled by this rule (or group, by role) ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
role		1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
code		1..1	code	Symbol in syntax defined by the system Fixed Value: IRCP
reference		1..1	Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Resource for the actor (or group, by role) ele-1: All FHIR elements must have a @value or children
purpose	SΣ	1..*	Coding	Context of activities covered by this rule Binding: IPS.HAJJ.CONSENT ValueSet of consent policies (required) ele-1: All FHIR elements must have a @value or children
dataPeriod	SΣ	0..1	Period	Timeframe for data controlled by this rule ele-1: All FHIR elements must have a @value or children
Slices for data	SΣ	0..*	BackboneElement	Data controlled by this rule Slice: Unordered, Closed by value:meaning ele-1: All FHIR elements must have a @value or children
data:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children
reference	Σ	1..1	Reference(Resource)	The actual data reference ele-1: All FHIR elements must have a @value or children
data:iData	Σ	0..*	BackboneElement	Data controlled by this rule ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children Required Pattern: instance
reference	Σ	1..1	Reference(Resource)	The actual data reference ele-1: All FHIR elements must have a @value or children
data:rData	Σ	0..*	BackboneElement	Data controlled by this rule ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children Required Pattern: related
reference	Σ	1..1	Reference(Encounter | CarePlan | EpisodeOfCare)	The actual data reference ele-1: All FHIR elements must have a @value or children
data:aData	Σ	0..*	BackboneElement	Data controlled by this rule ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children Required Pattern: authoredby
reference	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson)	The actual data reference ele-1: All FHIR elements must have a @value or children
provision	S	0..*	BackboneElement	Nested Exception Rules ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
purpose	SΣ	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. ele-1: All FHIR elements must have a @value or children
dataPeriod	SΣ	0..1	Period	Timeframe for data controlled by this rule ele-1: All FHIR elements must have a @value or children
Slices for data	SΣ	0..*	BackboneElement	Data controlled by this rule Slice: Unordered, Closed by value:meaning ele-1: All FHIR elements must have a @value or children
data:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children
reference	Σ	1..1	Reference(Resource)	The actual data reference ele-1: All FHIR elements must have a @value or children
data:iDataP	Σ	0..1	BackboneElement	Data controlled by this rule ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children Required Pattern: instance
reference	Σ	1..1	Reference(Resource)	The actual data reference ele-1: All FHIR elements must have a @value or children
data:rDataP	Σ	0..1	BackboneElement	Data controlled by this rule ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children Required Pattern: related
reference	Σ	1..1	Reference(Encounter | CarePlan | EpisodeOfCare)	The actual data reference ele-1: All FHIR elements must have a @value or children
data:aDataP	Σ	0..1	BackboneElement	Data controlled by this rule ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children Required Pattern: authoredby
reference	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson)	The actual data reference ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 from the FHIR Standard
Consent.scope	extensible	Pattern: patient-privacy http://hl7.org/fhir/ValueSet/consent-scope from the FHIR Standard
Consent.category	extensible	ConsentCategoryCodes http://hl7.org/fhir/ValueSet/consent-category 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	Pattern: IRCP http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Consent.provision.purpose	required	IPS_HAJJ_CONSENT (a valid code from IPS.HAJJ.CONSENT CodeSystem) http://smart.who.int/ips-pilgrimage/ValueSet/IPS.HAJJ.CONSENT from this IG
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.data:iData.meaning	required	Pattern: instance http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.data:rData.meaning	required	Pattern: related http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.data:aData.meaning	required	Pattern: authoredby http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.purpose	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.data:iDataP.meaning	required	Pattern: instance http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.data:rDataP.meaning	required	Pattern: related http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.data:aDataP.meaning	required	Pattern: authoredby http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 IntermediateConsent

Name	Flags	Card.	Type	Description & Constraints
Consent		0..*	IntermediateConsent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
organization		1..*	Reference(HajjOrganization)	Custodian of the consent
provision
period		1..1	Period	Timeframe for this rule
purpose		1..*	Coding	Context of activities covered by this rule Binding: IPS.HAJJ.CONSENT ValueSet of consent policies (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Consent.provision.purpose	required	IPS_HAJJ_CONSENT (a valid code from IPS.HAJJ.CONSENT CodeSystem) http://smart.who.int/ips-pilgrimage/ValueSet/IPS.HAJJ.CONSENT from this IG

Name	Flags	Card.	Type	Description & Constraints
Consent	C	0..*	IntermediateConsent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
status	?!Σ	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent.
scope	?!Σ	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
category	Σ	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
patient	Σ	1..1	Reference(Patient)	Who the consent applies to
dateTime	Σ	1..1	dateTime	When this Consent was created or indexed
performer	Σ	1..*	Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Who is agreeing to the policy and rules
organization	Σ	1..*	Reference(HajjOrganization)	Custodian of the consent
source[x]	Σ	1..1		Source from which this consent is taken
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
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	1..1	uri	Specific policy covered by this consent
policyRule	ΣC	0..1	CodeableConcept	Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
provision	SΣ	1..1	BackboneElement	Constraints to the base Consent.policyRule
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	code	deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
period	SΣ	1..1	Period	Timeframe for this rule
actor	S	0..*	BackboneElement	Who|what controlled by this rule (or group, by role)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role		1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: IRCP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
reference		1..1	Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Resource for the actor (or group, by role)
purpose	SΣ	1..*	Coding	Context of activities covered by this rule Binding: IPS.HAJJ.CONSENT ValueSet of consent policies (required)
dataPeriod	SΣ	0..1	Period	Timeframe for data controlled by this rule
Slices for data	SΣ	0..*	BackboneElement	Data controlled by this rule Slice: Unordered, Closed by value:meaning
data:All Slices				Content/Rules for all slices
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
data:iData	Σ	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. Required Pattern: instance
reference	Σ	1..1	Reference(Resource)	The actual data reference
data:rData	Σ	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. Required Pattern: related
reference	Σ	1..1	Reference(Encounter | CarePlan | EpisodeOfCare)	The actual data reference
data:aData	Σ	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. Required Pattern: authoredby
reference	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson)	The actual data reference
provision	S	0..*	BackboneElement	Nested Exception Rules
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..1	code	deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
period	Σ	0..1	Period	Timeframe for this rule
actor		0..*	BackboneElement	Who|what controlled by this rule (or group, by role)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role		1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
reference		1..1	Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Resource for the actor (or group, by role)
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	SΣ	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	SΣ	0..1	Period	Timeframe for data controlled by this rule
Slices for data	SΣ	0..*	BackboneElement	Data controlled by this rule Slice: Unordered, Closed by value:meaning
data:All Slices				Content/Rules for all slices
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
data:iDataP	Σ	0..1	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. Required Pattern: instance
reference	Σ	1..1	Reference(Resource)	The actual data reference
data:rDataP	Σ	0..1	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. Required Pattern: related
reference	Σ	1..1	Reference(Encounter | CarePlan | EpisodeOfCare)	The actual data reference
data:aDataP	Σ	0..1	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. Required Pattern: authoredby
reference	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson)	The actual data reference
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 from the FHIR Standard
Consent.scope	extensible	Pattern: patient-privacy http://hl7.org/fhir/ValueSet/consent-scope from the FHIR Standard
Consent.category	extensible	ConsentCategoryCodes http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard
Consent.policyRule	extensible	ConsentPolicyRuleCodes 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	Pattern: IRCP http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Consent.provision.purpose	required	IPS_HAJJ_CONSENT (a valid code from IPS.HAJJ.CONSENT CodeSystem) http://smart.who.int/ips-pilgrimage/ValueSet/IPS.HAJJ.CONSENT from this IG
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.data:iData.meaning	required	Pattern: instance http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.data:rData.meaning	required	Pattern: related http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.data:aData.meaning	required	Pattern: authoredby http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.type	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard
Consent.provision.provision.actor.role	extensible	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Consent.provision.provision.action	example	ConsentActionCodes http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard
Consent.provision.provision.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Consent.provision.provision.purpose	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.provision.class	extensible	ConsentContentClass http://hl7.org/fhir/ValueSet/consent-content-class from the FHIR Standard
Consent.provision.provision.code	example	ConsentContentCodes (a valid code from LOINC) http://hl7.org/fhir/ValueSet/consent-content-code from the FHIR Standard
Consent.provision.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.data:iDataP.meaning	required	Pattern: instance http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.data:rDataP.meaning	required	Pattern: related http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.data:aDataP.meaning	required	Pattern: authoredby http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 IntermediateConsent

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

• HajjOrganization (http://smart.who.int/ips-pilgrimage/StructureDefinition/HajjOrganization)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Consent	C	0..*	IntermediateConsent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
status	?!Σ	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent. ele-1: All FHIR elements must have a @value or children
scope	?!Σ	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
code		1..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
category	Σ	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement. ele-1: All FHIR elements must have a @value or children
patient	Σ	1..1	Reference(Patient)	Who the consent applies to ele-1: All FHIR elements must have a @value or children
dateTime	Σ	1..1	dateTime	When this Consent was created or indexed ele-1: All FHIR elements must have a @value or children
performer	Σ	1..*	Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Who is agreeing to the policy and rules ele-1: All FHIR elements must have a @value or children
organization	Σ	1..*	Reference(HajjOrganization)	Custodian of the consent ele-1: All FHIR elements must have a @value or children
source[x]	Σ	1..1		Source from which this consent is taken ele-1: All FHIR elements must have a @value or children
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
provision	SΣ	1..1	BackboneElement	Constraints to the base Consent.policyRule ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
type	Σ	1..1	code	deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. ele-1: All FHIR elements must have a @value or children
period	SΣ	1..1	Period	Timeframe for this rule ele-1: All FHIR elements must have a @value or children
actor	S	0..*	BackboneElement	Who|what controlled by this rule (or group, by role) ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
role		1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
code		1..1	code	Symbol in syntax defined by the system Fixed Value: IRCP
reference		1..1	Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Resource for the actor (or group, by role) ele-1: All FHIR elements must have a @value or children
purpose	SΣ	1..*	Coding	Context of activities covered by this rule Binding: IPS.HAJJ.CONSENT ValueSet of consent policies (required) ele-1: All FHIR elements must have a @value or children
dataPeriod	SΣ	0..1	Period	Timeframe for data controlled by this rule ele-1: All FHIR elements must have a @value or children
Slices for data	SΣ	0..*	BackboneElement	Data controlled by this rule Slice: Unordered, Closed by value:meaning ele-1: All FHIR elements must have a @value or children
data:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children
reference	Σ	1..1	Reference(Resource)	The actual data reference ele-1: All FHIR elements must have a @value or children
data:iData	Σ	0..*	BackboneElement	Data controlled by this rule ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children Required Pattern: instance
reference	Σ	1..1	Reference(Resource)	The actual data reference ele-1: All FHIR elements must have a @value or children
data:rData	Σ	0..*	BackboneElement	Data controlled by this rule ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children Required Pattern: related
reference	Σ	1..1	Reference(Encounter | CarePlan | EpisodeOfCare)	The actual data reference ele-1: All FHIR elements must have a @value or children
data:aData	Σ	0..*	BackboneElement	Data controlled by this rule ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children Required Pattern: authoredby
reference	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson)	The actual data reference ele-1: All FHIR elements must have a @value or children
provision	S	0..*	BackboneElement	Nested Exception Rules ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
purpose	SΣ	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. ele-1: All FHIR elements must have a @value or children
dataPeriod	SΣ	0..1	Period	Timeframe for data controlled by this rule ele-1: All FHIR elements must have a @value or children
Slices for data	SΣ	0..*	BackboneElement	Data controlled by this rule Slice: Unordered, Closed by value:meaning ele-1: All FHIR elements must have a @value or children
data:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children
reference	Σ	1..1	Reference(Resource)	The actual data reference ele-1: All FHIR elements must have a @value or children
data:iDataP	Σ	0..1	BackboneElement	Data controlled by this rule ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children Required Pattern: instance
reference	Σ	1..1	Reference(Resource)	The actual data reference ele-1: All FHIR elements must have a @value or children
data:rDataP	Σ	0..1	BackboneElement	Data controlled by this rule ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children Required Pattern: related
reference	Σ	1..1	Reference(Encounter | CarePlan | EpisodeOfCare)	The actual data reference ele-1: All FHIR elements must have a @value or children
data:aDataP	Σ	0..1	BackboneElement	Data controlled by this rule ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both
meaning	Σ	1..1	code	instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. ele-1: All FHIR elements must have a @value or children Required Pattern: authoredby
reference	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson)	The actual data reference ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 from the FHIR Standard
Consent.scope	extensible	Pattern: patient-privacy http://hl7.org/fhir/ValueSet/consent-scope from the FHIR Standard
Consent.category	extensible	ConsentCategoryCodes http://hl7.org/fhir/ValueSet/consent-category 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	Pattern: IRCP http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Consent.provision.purpose	required	IPS_HAJJ_CONSENT (a valid code from IPS.HAJJ.CONSENT CodeSystem) http://smart.who.int/ips-pilgrimage/ValueSet/IPS.HAJJ.CONSENT from this IG
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.data:iData.meaning	required	Pattern: instance http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.data:rData.meaning	required	Pattern: related http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.data:aData.meaning	required	Pattern: authoredby http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.purpose	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.data:iDataP.meaning	required	Pattern: instance http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.data:rDataP.meaning	required	Pattern: related http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.data:aDataP.meaning	required	Pattern: authoredby http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 IntermediateConsent

Name	Flags	Card.	Type	Description & Constraints
Consent		0..*	IntermediateConsent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
organization		1..*	Reference(HajjOrganization)	Custodian of the consent
provision
period		1..1	Period	Timeframe for this rule
purpose		1..*	Coding	Context of activities covered by this rule Binding: IPS.HAJJ.CONSENT ValueSet of consent policies (required)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
Consent.provision.purpose	required	IPS_HAJJ_CONSENT (a valid code from IPS.HAJJ.CONSENT CodeSystem) http://smart.who.int/ips-pilgrimage/ValueSet/IPS.HAJJ.CONSENT from this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Consent	C	0..*	IntermediateConsent	A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time ppc-1: Either a Policy or PolicyRule ppc-2: IF Scope=privacy, there must be a patient ppc-3: IF Scope=research, there must be a patient ppc-4: IF Scope=adr, there must be a patient ppc-5: IF Scope=treatment, there must be a patient
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier for this record (external references) Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
status	?!Σ	1..1	code	draft | proposed | active | rejected | inactive | entered-in-error Binding: ConsentState (required): Indicates the state of the consent.
scope	?!Σ	1..1	CodeableConcept	Which of the four areas this resource covers (extensible) Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: patient-privacy
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
category	Σ	1..*	CodeableConcept	Classification of the consent statement - for indexing/retrieval Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
patient	Σ	1..1	Reference(Patient)	Who the consent applies to
dateTime	Σ	1..1	dateTime	When this Consent was created or indexed
performer	Σ	1..*	Reference(Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Who is agreeing to the policy and rules
organization	Σ	1..*	Reference(HajjOrganization)	Custodian of the consent
source[x]	Σ	1..1		Source from which this consent is taken
sourceAttachment			Attachment
sourceReference			Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)
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	1..1	uri	Specific policy covered by this consent
policyRule	ΣC	0..1	CodeableConcept	Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
provision	SΣ	1..1	BackboneElement	Constraints to the base Consent.policyRule
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	1..1	code	deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
period	SΣ	1..1	Period	Timeframe for this rule
actor	S	0..*	BackboneElement	Who|what controlled by this rule (or group, by role)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role		1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
coding		1..*	Coding	Code defined by a terminology system Fixed Value: (complex)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: IRCP
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
text		0..1	string	Plain text representation of the concept
reference		1..1	Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Resource for the actor (or group, by role)
purpose	SΣ	1..*	Coding	Context of activities covered by this rule Binding: IPS.HAJJ.CONSENT ValueSet of consent policies (required)
dataPeriod	SΣ	0..1	Period	Timeframe for data controlled by this rule
Slices for data	SΣ	0..*	BackboneElement	Data controlled by this rule Slice: Unordered, Closed by value:meaning
data:All Slices				Content/Rules for all slices
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
data:iData	Σ	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. Required Pattern: instance
reference	Σ	1..1	Reference(Resource)	The actual data reference
data:rData	Σ	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. Required Pattern: related
reference	Σ	1..1	Reference(Encounter | CarePlan | EpisodeOfCare)	The actual data reference
data:aData	Σ	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. Required Pattern: authoredby
reference	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson)	The actual data reference
provision	S	0..*	BackboneElement	Nested Exception Rules
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	Σ	0..1	code	deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
period	Σ	0..1	Period	Timeframe for this rule
actor		0..*	BackboneElement	Who|what controlled by this rule (or group, by role)
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role		1..1	CodeableConcept	How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
reference		1..1	Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)	Resource for the actor (or group, by role)
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	SΣ	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	SΣ	0..1	Period	Timeframe for data controlled by this rule
Slices for data	SΣ	0..*	BackboneElement	Data controlled by this rule Slice: Unordered, Closed by value:meaning
data:All Slices				Content/Rules for all slices
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
data:iDataP	Σ	0..1	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. Required Pattern: instance
reference	Σ	1..1	Reference(Resource)	The actual data reference
data:rDataP	Σ	0..1	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. Required Pattern: related
reference	Σ	1..1	Reference(Encounter | CarePlan | EpisodeOfCare)	The actual data reference
data:aDataP	Σ	0..1	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. Required Pattern: authoredby
reference	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization | Device | Group | CareTeam | Patient | RelatedPerson)	The actual data reference
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages from the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1 from the FHIR Standard
Consent.scope	extensible	Pattern: patient-privacy http://hl7.org/fhir/ValueSet/consent-scope from the FHIR Standard
Consent.category	extensible	ConsentCategoryCodes http://hl7.org/fhir/ValueSet/consent-category from the FHIR Standard
Consent.policyRule	extensible	ConsentPolicyRuleCodes 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	Pattern: IRCP http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Consent.provision.purpose	required	IPS_HAJJ_CONSENT (a valid code from IPS.HAJJ.CONSENT CodeSystem) http://smart.who.int/ips-pilgrimage/ValueSet/IPS.HAJJ.CONSENT from this IG
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.data:iData.meaning	required	Pattern: instance http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.data:rData.meaning	required	Pattern: related http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.data:aData.meaning	required	Pattern: authoredby http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.type	required	ConsentProvisionType http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1 from the FHIR Standard
Consent.provision.provision.actor.role	extensible	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
Consent.provision.provision.action	example	ConsentActionCodes http://hl7.org/fhir/ValueSet/consent-action from the FHIR Standard
Consent.provision.provision.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard
Consent.provision.provision.purpose	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.provision.class	extensible	ConsentContentClass http://hl7.org/fhir/ValueSet/consent-content-class from the FHIR Standard
Consent.provision.provision.code	example	ConsentContentCodes (a valid code from LOINC) http://hl7.org/fhir/ValueSet/consent-content-code from the FHIR Standard
Consent.provision.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.data:iDataP.meaning	required	Pattern: instance http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.data:rDataP.meaning	required	Pattern: related http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard
Consent.provision.provision.data:aDataP.meaning	required	Pattern: authoredby http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1 from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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 IntermediateConsent

Summary

Mandatory: 2 elements

Structures

This structure refers to these other structures:

• HajjOrganization (http://smart.who.int/ips-pilgrimage/StructureDefinition/HajjOrganization)