Comments on the composition

Status:

• active: Consent is present and currently valid.
• inactive: Consent is present but has expired. For example, old/expired information or because the consent was withdrawn by the patient.

Category:
FHIR ConsentScope: treatment
General category for patient consent regarding treatment.

Provision.code:
LOINC: 61358-8 Surgical operation consent Document
Specifies that it is a written surgery consent.

SourceAttachment:
Link to the signed document of the Consent from KISIM or customer-specific archive.

Decision:
Fixed value deny, as this becomes a permission the provision and usually only accepted surgery consents are uploaded to KISIM.

Extensions:

• consentTranscriber: To record which user has uploaded/edited the PDF. Represents the visa/initials.
  

View in KISIM

Scanned PDF of the consent in the register 'Berichte'.

Examples

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	KisimCoreConsent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:consentTranscriber	S	1..1	(Complex)	Transcribed consent URL: http://hl7.org/fhir/StructureDefinition/consent-Transcriber
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/consent-Transcriber"
value[x]		1..1	Reference(Practitioner)	User who records the entry in the system.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	active | inactive => active for Consent present and valid, inactive for expired/past Consent. Binding: ConsentState (required): Indicates the state of the consent.
category	SΣ	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types. Binding: ConsentCategoriesVS (required)
subject	SΣ	1..1	Reference(Patient)	The patient to whom this consent applies to.
date	SΣ	1..1	date	Respresents the date when the entry to the system was made.
period	SΣ	1..1	Period	Effective period for this Consent
start	SΣC	1..1	dateTime	Starting time with inclusive boundary
grantor	SΣ	1..1	Reference(Patient | RelatedPerson | Organization)	Person who has given or denied consent. Generally either patient or legal representative.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Either Patient or RelatedPerson. Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Either Patient ID or RelatedPerson ID. Example General: 123456
grantee	SΣ	1..1	Reference(Organization)	Organization that must follow the instructions of the Consent or is granted rights.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Organization Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. Example General: 123456
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
manager	S	1..1	Reference(HealthcareService)	Application that recorded/changed the consent. For instance a CIS or a Patientportal.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: HealthcareService
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Name of the Application as defined in the referenced resource. Example General: 123456
display	SΣC	1..1	string	Name of the Application as defined in the referenced resource.
controller	S	1..1	Reference(Organization)	Organization to which the Consent applies.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. Example General: 123456
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
sourceAttachment	S	1..*	Attachment	Document that represents the consent.
url	Σ	0..1	url	Link to the written document. Example General: http://www.acme.com/logo-small.png
decision	?!SΣ	1..1	code	Only deny, as this becomes a permit in the provision and no consent is recorded if denied. Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level. Required Pattern: deny
provision	SΣ	1..*	BackboneElement	Exeptions/Constraints to the base decision.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	SΣ	1..*	CodeableConcept	Additional classification of consent, used with category to identify consent types. Binding: ConsentProvisionCodesVS (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0 From the FHIR Standard
Consent.category	required	ConsentCategoriesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVS From this IG
Consent.grantor.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantor.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.grantee.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantee.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.manager.type	extensible	Pattern Value: HealthcareService http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.manager.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.controller.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.controller.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.decision	required	Pattern Value: deny http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0 From the FHIR Standard
Consent.provision.code	required	ConsentProvisionCodesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVS From this IG

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()

This structure is derived from KisimCoreConsent

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	KisimCoreConsent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:consentTranscriber	S	1..1	(Complex)	Transcribed consent URL: http://hl7.org/fhir/StructureDefinition/consent-Transcriber
value[x]		1..1	Reference(Practitioner)	User who records the entry in the system.
status		1..1	code	active | inactive => active for Consent present and valid, inactive for expired/past Consent.
category
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
code		0..1	code	Symbol in syntax defined by the system Required Pattern: treatment
grantee		1..1	Reference(Organization)	Organization that must follow the instructions of the Consent or is granted rights.
type		1..1	uri	Organization Required Pattern: Organization
identifier
value		0..1	string	UID of the Organization.
display		1..1	string	Name of the Organization as defined in the referenced resource.
sourceAttachment	S	1..*	Attachment	Document that represents the consent.
url		0..1	url	Link to the written document.
decision		1..1	code	Only deny, as this becomes a permit in the provision and no consent is recorded if denied. Required Pattern: deny
provision
code
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://loinc.org
code		0..1	code	Symbol in syntax defined by the system Required Pattern: 61358-8
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	KisimCoreConsent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:consentTranscriber	S	1..1	(Complex)	Transcribed consent URL: http://hl7.org/fhir/StructureDefinition/consent-Transcriber
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/consent-Transcriber"
value[x]		1..1	Reference(Practitioner)	User who records the entry in the system.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier for this record (external references)
status	?!SΣ	1..1	code	active | inactive => active for Consent present and valid, inactive for expired/past Consent. Binding: ConsentState (required): Indicates the state of the consent.
category	SΣ	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types. Binding: ConsentCategoriesVS (required)
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	0..1	code	Symbol in syntax defined by the system Required Pattern: treatment
display	ΣC	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
subject	SΣ	1..1	Reference(Patient)	The patient to whom this consent applies to.
date	SΣ	1..1	date	Respresents the date when the entry to the system was made.
period	SΣ	1..1	Period	Effective period for this Consent
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	SΣC	1..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
grantor	SΣ	1..1	Reference(Patient | RelatedPerson | Organization)	Person who has given or denied consent. Generally either patient or legal representative.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Either Patient or RelatedPerson. Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	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 .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Either Patient ID or RelatedPerson ID. 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)
display	ΣC	0..1	string	Text alternative for the resource
grantee	SΣ	1..1	Reference(Organization)	Organization that must follow the instructions of the Consent or is granted rights.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Organization Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	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 .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. 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)
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
manager	S	1..1	Reference(HealthcareService)	Application that recorded/changed the consent. For instance a CIS or a Patientportal.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: HealthcareService
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	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 .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Name of the Application as defined in the referenced resource. 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)
display	SΣC	1..1	string	Name of the Application as defined in the referenced resource.
controller	S	1..1	Reference(Organization)	Organization to which the Consent applies.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	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 .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. 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)
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
sourceAttachment	S	1..*	Attachment	Document that represents the consent.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	ΣC	0..1	code	Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language. Additional Bindings Purpose CommonLanguages Starter Example General: en-AU
data	C	0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Link to the written document. Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	integer64	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
height		0..1	positiveInt	Height of the image in pixels (photo/video)
width		0..1	positiveInt	Width of the image in pixels (photo/video)
frames		0..1	positiveInt	Number of frames if > 1 (photo)
duration		0..1	decimal	Length in seconds (audio / video)
pages		0..1	positiveInt	Number of printed pages
sourceReference		0..*	Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)	Source from which this consent is taken
regulatoryBasis		0..*	CodeableConcept	Regulations establishing base Consent Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples
policyBasis		0..1	BackboneElement	Computable version of the backing policy
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
reference		0..1	Reference(Resource)	Reference backing policy resource
url		0..1	url	URL to a computable backing policy
policyText		0..*	Reference(DocumentReference)	Human Readable Policy
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
verificationType		0..1	CodeableConcept	Business case of verification Binding: ConsentVerificationCodes (example): Types of Verification/Validation.
verifiedBy		0..1	Reference(Organization | Practitioner | PractitionerRole)	Person conducting verification
verifiedWith		0..1	Reference(Patient | RelatedPerson)	Person who verified
verificationDate		0..*	dateTime	When consent verified
decision	?!SΣ	1..1	code	Only deny, as this becomes a permit in the provision and no consent is recorded if denied. Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level. Required Pattern: deny
provision	SΣ	1..*	BackboneElement	Exeptions/Constraints to the base decision.
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
period	Σ	0..1	Period	Timeframe for this provision
actor		0..*	BackboneElement	Who|what controlled by this provision (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		0..1	CodeableConcept	How the actor is involved Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations.
reference		0..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 provision Binding: ConsentActionCodes (example): Detailed codes for the consent action.
securityLabel	Σ	0..*	Coding	Security Labels that define affected resources Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
purpose	Σ	0..*	Coding	Context of activities covered by this provision 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.
documentType	Σ	0..*	Coding	e.g. Resource Type, Profile, CDA, etc Binding: ConsentContentClass (preferred): The document type a consent provision covers.
resourceType	Σ	0..*	Coding	e.g. Resource Type, Profile, etc Binding: ResourceType (extensible): The resource types a consent provision covers.
code	SΣ	1..*	CodeableConcept	Additional classification of consent, used with category to identify consent types. Binding: ConsentProvisionCodesVS (required)
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://loinc.org
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	0..1	code	Symbol in syntax defined by the system Required Pattern: 61358-8
display	ΣC	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
dataPeriod	Σ	0..1	Period	Timeframe for data controlled by this provision
data	Σ	0..*	BackboneElement	Data controlled by this provision
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
expression		0..1	Expression	A computable expression of the consent
provision		0..*	See provision (Consent)	Nested Exception Provisions
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0 From the FHIR Standard
Consent.category	required	ConsentCategoriesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVS From this IG
Consent.grantor.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantor.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.grantor.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.grantee.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantee.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.grantee.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.manager.type	extensible	Pattern Value: HealthcareService http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.manager.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.manager.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.controller.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.controller.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.controller.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.sourceAttachment.contentType	required	MimeTypes(a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From the FHIR Standard
Consent.sourceAttachment.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard
Consent.regulatoryBasis	example	ConsentPolicyRuleCodes http://hl7.org/fhir/ValueSet/consent-policy From the FHIR Standard
Consent.verification.verificationType	example	ConsentVerificationCodes http://hl7.org/fhir/ValueSet/consent-verification From the FHIR Standard
Consent.decision	required	Pattern Value: deny http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0 From the FHIR Standard
Consent.provision.actor.role	extensible	ParticipationRoleType http://hl7.org/fhir/ValueSet/participation-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	example	SecurityLabelExamples http://hl7.org/fhir/ValueSet/security-label-examples From the FHIR Standard
Consent.provision.purpose	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.documentType	preferred	ConsentContentClass http://hl7.org/fhir/ValueSet/consent-content-class From the FHIR Standard
Consent.provision.resourceType	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.provision.code	required	ConsentProvisionCodesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVS From this IG
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	KisimCoreConsent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
contained		0..*	Resource	Contained, inline Resources
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:consentTranscriber	S	1..1	(Complex)	Transcribed consent URL: http://hl7.org/fhir/StructureDefinition/consent-Transcriber
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/consent-Transcriber"
value[x]		1..1	Reference(Practitioner)	User who records the entry in the system.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
status	?!SΣ	1..1	code	active | inactive => active for Consent present and valid, inactive for expired/past Consent. Binding: ConsentState (required): Indicates the state of the consent.
category	SΣ	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types. Binding: ConsentCategoriesVS (required)
subject	SΣ	1..1	Reference(Patient)	The patient to whom this consent applies to.
date	SΣ	1..1	date	Respresents the date when the entry to the system was made.
period	SΣ	1..1	Period	Effective period for this Consent
start	SΣC	1..1	dateTime	Starting time with inclusive boundary
grantor	SΣ	1..1	Reference(Patient | RelatedPerson | Organization)	Person who has given or denied consent. Generally either patient or legal representative.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Either Patient or RelatedPerson. Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Either Patient ID or RelatedPerson ID. Example General: 123456
grantee	SΣ	1..1	Reference(Organization)	Organization that must follow the instructions of the Consent or is granted rights.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Organization Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. Example General: 123456
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
manager	S	1..1	Reference(HealthcareService)	Application that recorded/changed the consent. For instance a CIS or a Patientportal.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: HealthcareService
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Name of the Application as defined in the referenced resource. Example General: 123456
display	SΣC	1..1	string	Name of the Application as defined in the referenced resource.
controller	S	1..1	Reference(Organization)	Organization to which the Consent applies.
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. Example General: 123456
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
sourceAttachment	S	1..*	Attachment	Document that represents the consent.
url	Σ	0..1	url	Link to the written document. Example General: http://www.acme.com/logo-small.png
decision	?!SΣ	1..1	code	Only deny, as this becomes a permit in the provision and no consent is recorded if denied. Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level. Required Pattern: deny
provision	SΣ	1..*	BackboneElement	Exeptions/Constraints to the base decision.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
code	SΣ	1..*	CodeableConcept	Additional classification of consent, used with category to identify consent types. Binding: ConsentProvisionCodesVS (required)
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0 From the FHIR Standard
Consent.category	required	ConsentCategoriesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVS From this IG
Consent.grantor.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantor.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.grantee.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantee.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.manager.type	extensible	Pattern Value: HealthcareService http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.manager.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.controller.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.controller.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.decision	required	Pattern Value: deny http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0 From the FHIR Standard
Consent.provision.code	required	ConsentProvisionCodesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVS From this IG

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()

Differential View

This structure is derived from KisimCoreConsent

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	KisimCoreConsent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:consentTranscriber	S	1..1	(Complex)	Transcribed consent URL: http://hl7.org/fhir/StructureDefinition/consent-Transcriber
value[x]		1..1	Reference(Practitioner)	User who records the entry in the system.
status		1..1	code	active | inactive => active for Consent present and valid, inactive for expired/past Consent.
category
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
code		0..1	code	Symbol in syntax defined by the system Required Pattern: treatment
grantee		1..1	Reference(Organization)	Organization that must follow the instructions of the Consent or is granted rights.
type		1..1	uri	Organization Required Pattern: Organization
identifier
value		0..1	string	UID of the Organization.
display		1..1	string	Name of the Organization as defined in the referenced resource.
sourceAttachment	S	1..*	Attachment	Document that represents the consent.
url		0..1	url	Link to the written document.
decision		1..1	code	Only deny, as this becomes a permit in the provision and no consent is recorded if denied. Required Pattern: deny
provision
code
coding
system		0..1	uri	Identity of the terminology system Required Pattern: http://loinc.org
code		0..1	code	Symbol in syntax defined by the system Required Pattern: 61358-8
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Consent		0..*	KisimCoreConsent	A healthcare consumer's or third party's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter
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
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension:consentTranscriber	S	1..1	(Complex)	Transcribed consent URL: http://hl7.org/fhir/StructureDefinition/consent-Transcriber
id		0..1	id	Unique id for inter-element referencing
extension		0..0
url		1..1	uri	"http://hl7.org/fhir/StructureDefinition/consent-Transcriber"
value[x]		1..1	Reference(Practitioner)	User who records the entry in the system.
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
identifier	Σ	0..*	Identifier	Identifier for this record (external references)
status	?!SΣ	1..1	code	active | inactive => active for Consent present and valid, inactive for expired/past Consent. Binding: ConsentState (required): Indicates the state of the consent.
category	SΣ	1..*	CodeableConcept	Initial classification of consent, used with provision.code to identify consent types. Binding: ConsentCategoriesVS (required)
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentscope
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	0..1	code	Symbol in syntax defined by the system Required Pattern: treatment
display	ΣC	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
subject	SΣ	1..1	Reference(Patient)	The patient to whom this consent applies to.
date	SΣ	1..1	date	Respresents the date when the entry to the system was made.
period	SΣ	1..1	Period	Effective period for this Consent
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
start	SΣC	1..1	dateTime	Starting time with inclusive boundary
end	ΣC	0..1	dateTime	End time with inclusive boundary, if not ongoing
grantor	SΣ	1..1	Reference(Patient | RelatedPerson | Organization)	Person who has given or denied consent. Generally either patient or legal representative.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Either Patient or RelatedPerson. Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	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 .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Either Patient ID or RelatedPerson ID. 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)
display	ΣC	0..1	string	Text alternative for the resource
grantee	SΣ	1..1	Reference(Organization)	Organization that must follow the instructions of the Consent or is granted rights.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Organization Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	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 .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. 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)
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
manager	S	1..1	Reference(HealthcareService)	Application that recorded/changed the consent. For instance a CIS or a Patientportal.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: HealthcareService
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	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 .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	Name of the Application as defined in the referenced resource. 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)
display	SΣC	1..1	string	Name of the Application as defined in the referenced resource.
controller	S	1..1	Reference(Organization)	Organization to which the Consent applies.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	SΣ	1..1	uri	Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization
identifier	ΣC	0..1	Identifier	Logical reference, when literal reference is not known
id		0..1	id	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 .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	SΣ	0..1	uri	urn:oid Example General: http://www.acme.com/identifiers/patient
value	SΣC	0..1	string	UID of the Organization. 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)
display	SΣC	1..1	string	Name of the Organization as defined in the referenced resource.
sourceAttachment	S	1..*	Attachment	Document that represents the consent.
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
contentType	ΣC	0..1	code	Mime type of the content, with charset etc. Binding: MimeTypes (required): BCP 13 (RFCs 2045, 2046, 2047, 4288, 4289 and 2049) Example General: text/plain; charset=UTF-8, image/png
language	Σ	0..1	code	Human language of the content (BCP-47) Binding: AllLanguages (required): IETF language tag for a human language. Additional Bindings Purpose CommonLanguages Starter Example General: en-AU
data	C	0..1	base64Binary	Data inline, base64ed
url	Σ	0..1	url	Link to the written document. Example General: http://www.acme.com/logo-small.png
size	Σ	0..1	integer64	Number of bytes of content (if url provided)
hash	Σ	0..1	base64Binary	Hash of the data (sha-1, base64ed)
title	Σ	0..1	string	Label to display in place of the data Example General: Official Corporate Logo
creation	Σ	0..1	dateTime	Date attachment was first created
height		0..1	positiveInt	Height of the image in pixels (photo/video)
width		0..1	positiveInt	Width of the image in pixels (photo/video)
frames		0..1	positiveInt	Number of frames if > 1 (photo)
duration		0..1	decimal	Length in seconds (audio / video)
pages		0..1	positiveInt	Number of printed pages
sourceReference		0..*	Reference(Consent | DocumentReference | Contract | QuestionnaireResponse)	Source from which this consent is taken
regulatoryBasis		0..*	CodeableConcept	Regulations establishing base Consent Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples
policyBasis		0..1	BackboneElement	Computable version of the backing policy
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
reference		0..1	Reference(Resource)	Reference backing policy resource
url		0..1	url	URL to a computable backing policy
policyText		0..*	Reference(DocumentReference)	Human Readable Policy
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
verificationType		0..1	CodeableConcept	Business case of verification Binding: ConsentVerificationCodes (example): Types of Verification/Validation.
verifiedBy		0..1	Reference(Organization | Practitioner | PractitionerRole)	Person conducting verification
verifiedWith		0..1	Reference(Patient | RelatedPerson)	Person who verified
verificationDate		0..*	dateTime	When consent verified
decision	?!SΣ	1..1	code	Only deny, as this becomes a permit in the provision and no consent is recorded if denied. Binding: ConsentProvisionType (required): Sets the base decision for Consent to be either permit or deny, with provisions assumed to be a negation of the previous level. Required Pattern: deny
provision	SΣ	1..*	BackboneElement	Exeptions/Constraints to the base decision.
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
period	Σ	0..1	Period	Timeframe for this provision
actor		0..*	BackboneElement	Who|what controlled by this provision (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		0..1	CodeableConcept	How the actor is involved Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations.
reference		0..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 provision Binding: ConsentActionCodes (example): Detailed codes for the consent action.
securityLabel	Σ	0..*	Coding	Security Labels that define affected resources Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
purpose	Σ	0..*	Coding	Context of activities covered by this provision 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.
documentType	Σ	0..*	Coding	e.g. Resource Type, Profile, CDA, etc Binding: ConsentContentClass (preferred): The document type a consent provision covers.
resourceType	Σ	0..*	Coding	e.g. Resource Type, Profile, etc Binding: ResourceType (extensible): The resource types a consent provision covers.
code	SΣ	1..*	CodeableConcept	Additional classification of consent, used with category to identify consent types. Binding: ConsentProvisionCodesVS (required)
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
coding	Σ	0..*	Coding	Code defined by a terminology system
id		0..1	id	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://loinc.org
version	Σ	0..1	string	Version of the system - if relevant
code	ΣC	0..1	code	Symbol in syntax defined by the system Required Pattern: 61358-8
display	ΣC	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
dataPeriod	Σ	0..1	Period	Timeframe for data controlled by this provision
data	Σ	0..*	BackboneElement	Data controlled by this provision
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
expression		0..1	Expression	A computable expression of the consent
provision		0..*	See provision (Consent)	Nested Exception Provisions
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
Consent.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard
Consent.status	required	ConsentState http://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0 From the FHIR Standard
Consent.category	required	ConsentCategoriesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVS From this IG
Consent.grantor.type	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantor.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.grantor.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.grantee.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.grantee.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.grantee.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.manager.type	extensible	Pattern Value: HealthcareService http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.manager.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.manager.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.controller.type	extensible	Pattern Value: Organization http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.controller.identifier.use	required	IdentifierUse http://hl7.org/fhir/ValueSet/identifier-use|5.0.0 From the FHIR Standard
Consent.controller.identifier.type	extensible	IdentifierTypeCodes http://hl7.org/fhir/ValueSet/identifier-type From the FHIR Standard
Consent.sourceAttachment.contentType	required	MimeTypes(a valid code from urn:ietf:bcp:13) http://hl7.org/fhir/ValueSet/mimetypes|5.0.0 From the FHIR Standard
Consent.sourceAttachment.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0 From the FHIR Standard
Consent.regulatoryBasis	example	ConsentPolicyRuleCodes http://hl7.org/fhir/ValueSet/consent-policy From the FHIR Standard
Consent.verification.verificationType	example	ConsentVerificationCodes http://hl7.org/fhir/ValueSet/consent-verification From the FHIR Standard
Consent.decision	required	Pattern Value: deny http://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0 From the FHIR Standard
Consent.provision.actor.role	extensible	ParticipationRoleType http://hl7.org/fhir/ValueSet/participation-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	example	SecurityLabelExamples http://hl7.org/fhir/ValueSet/security-label-examples From the FHIR Standard
Consent.provision.purpose	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Consent.provision.documentType	preferred	ConsentContentClass http://hl7.org/fhir/ValueSet/consent-content-class From the FHIR Standard
Consent.provision.resourceType	extensible	ResourceType http://hl7.org/fhir/ValueSet/resource-types From the FHIR Standard
Consent.provision.code	required	ConsentProvisionCodesVS http://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVS From this IG
Consent.provision.data.meaning	required	ConsentDataMeaning http://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()

This structure is derived from KisimCoreConsent

Summary

Mandatory: 4 elements
Must-Support: 2 elements

Extensions

This structure refers to these extensions:

• http://hl7.org/fhir/StructureDefinition/consent-Transcriber