0.1.2 - ci-build
CH
KISIMConsent - Local Development build (v0.1.2) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://fhir.kisimdocs.ch/ig/KisimConsent/StructureDefinition/KisimEPD | Version: 0.1.2 | |||
| Draft as of 2025-08-15 | Computable Name: KisimEPD | |||
KISIM specific representation of a Consent for the use of the electronic patient record (EPR) / Elektronisches Patientendossier (EPD)
Status:
Category:
FHIR ActCode: IDSCL Information disclosure
Category was taken over from CH Core ERP-Consent.
General category for information transfer.
Provision.code:
FHIR PolicyRuleCodes: ch-epr
Specification that this is the Swiss EPR.
Decision:
If a decision is set, then only deny, as this becomes a permit in the provision and no consent is recorded if the EPD is rejected.
Encounter exclusions are specified in provision.provision.
If no provision.provision is specified, the decision here applies to all encounters of the patient.
If the status is unknown (no EPR available), no decision is set.
Provision.provision.data:
Is only specified if upload restrictions are to apply to a specific encounter, e.g. encounter exclusion.
If several encounters are to be excluded from the upload, several provisions must be appended. One for each affected encounter.
The patient encounter number is specified.
Teilnahme:
Displayed in the "Patientenregister", in the "Stammdatenregister".
Encounter exclusion/Fallausschluss:
Displayed in the 'Fallregister' in the 'Stanmmdatenregister'.
Usages:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
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 | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive | unknown => active for EPR present with corresponding decision,
inactive as soon as patient changes/withdraws decision, unknown if no EPR exists. Binding: ConsentState (required): Indicates the state of the consent. |
![]() ![]() |
SΣ | 1..* | CodeableConcept | Initial classification of consent, used with provision.code to identify consent types. Binding: ConsentCategoriesVS (required) |
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | The patient to whom this consent applies to. |
![]() ![]() |
SΣ | 1..1 | date | Respresents the date when the entry to the system was made. |
![]() ![]() |
SΣ | 1..1 | Period | Effective period for this Consent |
![]() ![]() ![]() |
SΣC | 1..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() |
SΣ | 1..1 | Reference(Patient | RelatedPerson | Organization) | Person who has given or denied consent. Generally either patient or legal representative. |
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
SΣ | 1..1 | uri | Either Patient or RelatedPerson. Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Either Patient ID or RelatedPerson ID. Example General: 123456 |
![]() ![]() |
SΣ | 1..1 | Reference(Organization) | Organization that must follow the instructions of the Consent or is granted rights. |
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
SΣ | 1..1 | uri | Organization Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization |
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | UID of the Organization. Example General: 123456 |
![]() ![]() ![]() |
SΣC | 1..1 | string | Name of the Organization as defined in the referenced resource. |
![]() ![]() |
S | 1..1 | Reference(HealthcareService) | Application that recorded/changed the consent. For instance a CIS or a Patientportal. |
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Name of the Application as defined in the referenced resource. Example General: 123456 |
![]() ![]() ![]() |
SΣC | 1..1 | string | Name of the Application as defined in the referenced resource. |
![]() ![]() |
S | 1..1 | Reference(Organization) | Organization to which the Consent applies. |
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | UID of the Organization. Example General: 123456 |
![]() ![]() ![]() |
SΣC | 1..1 | string | Name of the Organization as defined in the referenced resource. |
![]() ![]() |
?!SΣ | 0..1 | code | deny = EPD present | No decision if no EPR exists or status unknown.
When changed/withdrawn, the status changes to inactive, but the decision remains the same. 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. |
![]() ![]() |
SΣ | 1..* | BackboneElement | Exeptions/Constraints to the base decision. |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Additional classification of consent, used with category to identify consent types. Binding: ConsentProvisionCodesVS (required) |
![]() ![]() ![]() |
0..* | BackboneElement | Is only specified if restrictions are only to apply to a specific case/encounter,
e.g. case exclusion (Fallausschluss).
A separate provision.provision must be created for each case/encounter concerned. | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Data controlled by this provision |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Encounter) | Encounter/Patientenfall for which an exception to the decision is to be made. |
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Encounternumber/Patientenfallnummer of the respective Encounter. Example General: 123456 |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0From the FHIR Standard | |
| Consent.category | required | ConsentCategoriesVShttp://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVSFrom this IG | |
| Consent.grantor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.grantor.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.grantee.type | extensible | Pattern Value: Organizationhttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.grantee.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.manager.type | extensible | Pattern Value: HealthcareServicehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.manager.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.controller.type | extensible | Pattern Value: Organizationhttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.controller.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.decision | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0From the FHIR Standard | |
| Consent.provision.code | required | ConsentProvisionCodesVShttp://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVSFrom this IG | |
| Consent.provision.provision.data.meaning | required | Pattern Value: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0From the FHIR Standard | |
| Consent.provision.provision.data.reference.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard |
| 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: ![]() ![]() |
|---|---|---|---|---|
![]() |
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 | |
![]() ![]() |
1..1 | code | active | inactive | unknown => active for EPR present with corresponding decision, inactive as soon as patient changes/withdraws decision, unknown if no EPR exists. | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Required Pattern: IDSCL | |
![]() ![]() |
1..1 | Reference(Organization) | Organization that must follow the instructions of the Consent or is granted rights. | |
![]() ![]() ![]() |
1..1 | uri | Organization Required Pattern: Organization | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | string | UID of the Organization. | |
![]() ![]() ![]() |
1..1 | string | Name of the Organization as defined in the referenced resource. | |
![]() ![]() |
0..1 | code | deny = EPD present | No decision if no EPR exists or status unknown. When changed/withdrawn, the status changes to inactive, but the decision remains the same. | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentpolicycodes | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Required Pattern: ch-epr | |
![]() ![]() ![]() |
0..* | BackboneElement | Is only specified if restrictions are only to apply to a specific case/encounter, e.g. case exclusion (Fallausschluss). A separate provision.provision must be created for each case/encounter concerned. | |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Data controlled by this provision |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | instance | related | dependents | authoredby Required Pattern: related |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Encounter) | Encounter/Patientenfall for which an exception to the decision is to be made. |
![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Encounternumber/Patientenfallnummer of the respective Encounter. |
Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
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 | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Identifier for this record (external references) | ||||
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive | unknown => active for EPR present with corresponding decision,
inactive as soon as patient changes/withdraws decision, unknown if no EPR exists. Binding: ConsentState (required): Indicates the state of the consent. | ||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | Initial classification of consent, used with provision.code to identify consent types. Binding: ConsentCategoriesVS (required) | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: IDSCL | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | The patient to whom this consent applies to. | ||||
![]() ![]() |
SΣ | 1..1 | date | Respresents the date when the entry to the system was made. | ||||
![]() ![]() |
SΣ | 1..1 | Period | Effective period for this Consent | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Patient | RelatedPerson | Organization) | Person who has given or denied consent. Generally either patient or legal representative. | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | Either Patient or RelatedPerson. Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Either Patient ID or RelatedPerson ID. Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Organization) | Organization that must follow the instructions of the Consent or is granted rights. | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | Organization Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | UID of the Organization. Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name of the Organization as defined in the referenced resource. | ||||
![]() ![]() |
S | 1..1 | Reference(HealthcareService) | Application that recorded/changed the consent. For instance a CIS or a Patientportal. | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Name of the Application as defined in the referenced resource. Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name of the Application as defined in the referenced resource. | ||||
![]() ![]() |
S | 1..1 | Reference(Organization) | Organization to which the Consent applies. | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | UID of the Organization. Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name of the Organization as defined in the referenced resource. | ||||
![]() ![]() |
0..* | Attachment | Source from which this consent is taken | |||||
![]() ![]() |
0..* | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | Source from which this consent is taken | |||||
![]() ![]() |
0..* | CodeableConcept | Regulations establishing base Consent Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples | |||||
![]() ![]() |
0..1 | BackboneElement | Computable version of the backing policy | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | Reference(Resource) | Reference backing policy resource | |||||
![]() ![]() ![]() |
0..1 | url | URL to a computable backing policy | |||||
![]() ![]() |
0..* | Reference(DocumentReference) | Human Readable Policy | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | boolean | Has been verified | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Business case of verification Binding: ConsentVerificationCodes (example): Types of Verification/Validation. | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization | Practitioner | PractitionerRole) | Person conducting verification | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
![]() ![]() ![]() |
0..* | dateTime | When consent verified | |||||
![]() ![]() |
?!SΣ | 0..1 | code | deny = EPD present | No decision if no EPR exists or status unknown.
When changed/withdrawn, the status changes to inactive, but the decision remains the same. 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. | ||||
![]() ![]() |
SΣ | 1..* | BackboneElement | Exeptions/Constraints to the base decision. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for this provision | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Who|what controlled by this provision (or group, by role) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | How the actor is involved Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations. | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Actions controlled by this provision Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels that define affected resources Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc Binding: ConsentContentClass (preferred): The document type a consent provision covers. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | e.g. Resource Type, Profile, etc Binding: ResourceType (extensible): The resource types a consent provision covers. | ||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Additional classification of consent, used with category to identify consent types. Binding: ConsentProvisionCodesVS (required) | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentpolicycodes | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: ch-epr | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for data controlled by this provision | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Data controlled by this provision | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
![]() ![]() ![]() |
0..1 | Expression | A computable expression of the consent | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Is only specified if restrictions are only to apply to a specific case/encounter,
e.g. case exclusion (Fallausschluss).
A separate provision.provision must be created for each case/encounter concerned. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for this provision | ||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Who|what controlled by this provision (or group, by role) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | How the actor is involved Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Actions controlled by this provision Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels that define affected resources Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc Binding: ConsentContentClass (preferred): The document type a consent provision covers. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | e.g. Resource Type, Profile, etc Binding: ResourceType (extensible): The resource types a consent provision covers. | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for data controlled by this provision | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Data controlled by this provision | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Encounter) | Encounter/Patientenfall for which an exception to the decision is to be made. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..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). | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Encounternumber/Patientenfallnummer of the respective Encounter. Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | Expression | A computable expression of the consent | |||||
![]() ![]() ![]() ![]() |
0..* | See provision (Consent) | Nested Exception Provisions | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Consent.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0From the FHIR Standard | |
| Consent.category | required | ConsentCategoriesVShttp://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVSFrom this IG | |
| Consent.grantor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.grantor.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.grantor.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Consent.grantee.type | extensible | Pattern Value: Organizationhttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.grantee.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.grantee.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Consent.manager.type | extensible | Pattern Value: HealthcareServicehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.manager.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.manager.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Consent.controller.type | extensible | Pattern Value: Organizationhttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.controller.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.controller.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Consent.regulatoryBasis | example | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policyFrom the FHIR Standard | |
| Consent.verification.verificationType | example | ConsentVerificationCodeshttp://hl7.org/fhir/ValueSet/consent-verificationFrom the FHIR Standard | |
| Consent.decision | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0From the FHIR Standard | |
| Consent.provision.actor.role | extensible | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-typeFrom the FHIR Standard | |
| Consent.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-actionFrom the FHIR Standard | |
| Consent.provision.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examplesFrom the FHIR Standard | |
| Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | |
| Consent.provision.documentType | preferred | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classFrom the FHIR Standard | |
| Consent.provision.resourceType | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.provision.code | required | ConsentProvisionCodesVShttp://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVSFrom this IG | |
| Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0From the FHIR Standard | |
| Consent.provision.provision.actor.role | extensible | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-typeFrom the FHIR Standard | |
| Consent.provision.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-actionFrom the FHIR Standard | |
| Consent.provision.provision.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examplesFrom the FHIR Standard | |
| Consent.provision.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | |
| Consent.provision.provision.documentType | preferred | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classFrom the FHIR Standard | |
| Consent.provision.provision.resourceType | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.provision.provision.code | example | ConsentContentCodeshttp://hl7.org/fhir/ValueSet/consent-content-codeFrom the FHIR Standard | |
| Consent.provision.provision.data.meaning | required | Pattern Value: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0From the FHIR Standard | |
| Consent.provision.provision.data.reference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.provision.provision.data.reference.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.provision.provision.data.reference.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
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 | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive | unknown => active for EPR present with corresponding decision,
inactive as soon as patient changes/withdraws decision, unknown if no EPR exists. Binding: ConsentState (required): Indicates the state of the consent. |
![]() ![]() |
SΣ | 1..* | CodeableConcept | Initial classification of consent, used with provision.code to identify consent types. Binding: ConsentCategoriesVS (required) |
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | The patient to whom this consent applies to. |
![]() ![]() |
SΣ | 1..1 | date | Respresents the date when the entry to the system was made. |
![]() ![]() |
SΣ | 1..1 | Period | Effective period for this Consent |
![]() ![]() ![]() |
SΣC | 1..1 | dateTime | Starting time with inclusive boundary |
![]() ![]() |
SΣ | 1..1 | Reference(Patient | RelatedPerson | Organization) | Person who has given or denied consent. Generally either patient or legal representative. |
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
SΣ | 1..1 | uri | Either Patient or RelatedPerson. Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). |
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Either Patient ID or RelatedPerson ID. Example General: 123456 |
![]() ![]() |
SΣ | 1..1 | Reference(Organization) | Organization that must follow the instructions of the Consent or is granted rights. |
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
SΣ | 1..1 | uri | Organization Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization |
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | UID of the Organization. Example General: 123456 |
![]() ![]() ![]() |
SΣC | 1..1 | string | Name of the Organization as defined in the referenced resource. |
![]() ![]() |
S | 1..1 | Reference(HealthcareService) | Application that recorded/changed the consent. For instance a CIS or a Patientportal. |
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Name of the Application as defined in the referenced resource. Example General: 123456 |
![]() ![]() ![]() |
SΣC | 1..1 | string | Name of the Application as defined in the referenced resource. |
![]() ![]() |
S | 1..1 | Reference(Organization) | Organization to which the Consent applies. |
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient |
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | UID of the Organization. Example General: 123456 |
![]() ![]() ![]() |
SΣC | 1..1 | string | Name of the Organization as defined in the referenced resource. |
![]() ![]() |
?!SΣ | 0..1 | code | deny = EPD present | No decision if no EPR exists or status unknown.
When changed/withdrawn, the status changes to inactive, but the decision remains the same. 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. |
![]() ![]() |
SΣ | 1..* | BackboneElement | Exeptions/Constraints to the base decision. |
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Additional classification of consent, used with category to identify consent types. Binding: ConsentProvisionCodesVS (required) |
![]() ![]() ![]() |
0..* | BackboneElement | Is only specified if restrictions are only to apply to a specific case/encounter,
e.g. case exclusion (Fallausschluss).
A separate provision.provision must be created for each case/encounter concerned. | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Data controlled by this provision |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related |
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Encounter) | Encounter/Patientenfall for which an exception to the decision is to be made. |
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Encounternumber/Patientenfallnummer of the respective Encounter. Example General: 123456 |
Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0From the FHIR Standard | |
| Consent.category | required | ConsentCategoriesVShttp://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVSFrom this IG | |
| Consent.grantor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.grantor.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.grantee.type | extensible | Pattern Value: Organizationhttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.grantee.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.manager.type | extensible | Pattern Value: HealthcareServicehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.manager.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.controller.type | extensible | Pattern Value: Organizationhttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.controller.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.decision | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0From the FHIR Standard | |
| Consent.provision.code | required | ConsentProvisionCodesVShttp://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVSFrom this IG | |
| Consent.provision.provision.data.meaning | required | Pattern Value: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0From the FHIR Standard | |
| Consent.provision.provision.data.reference.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard |
| 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: ![]() ![]() |
|---|---|---|---|---|
![]() |
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 | |
![]() ![]() |
1..1 | code | active | inactive | unknown => active for EPR present with corresponding decision, inactive as soon as patient changes/withdraws decision, unknown if no EPR exists. | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode | |
![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Required Pattern: IDSCL | |
![]() ![]() |
1..1 | Reference(Organization) | Organization that must follow the instructions of the Consent or is granted rights. | |
![]() ![]() ![]() |
1..1 | uri | Organization Required Pattern: Organization | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | string | UID of the Organization. | |
![]() ![]() ![]() |
1..1 | string | Name of the Organization as defined in the referenced resource. | |
![]() ![]() |
0..1 | code | deny = EPD present | No decision if no EPR exists or status unknown. When changed/withdrawn, the status changes to inactive, but the decision remains the same. | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentpolicycodes | |
![]() ![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Required Pattern: ch-epr | |
![]() ![]() ![]() |
0..* | BackboneElement | Is only specified if restrictions are only to apply to a specific case/encounter, e.g. case exclusion (Fallausschluss). A separate provision.provision must be created for each case/encounter concerned. | |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Data controlled by this provision |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | instance | related | dependents | authoredby Required Pattern: related |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Encounter) | Encounter/Patientenfall for which an exception to the decision is to be made. |
![]() ![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Encounternumber/Patientenfallnummer of the respective Encounter. |
Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
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 | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 0..* | Identifier | Identifier for this record (external references) | ||||
![]() ![]() |
?!SΣ | 1..1 | code | active | inactive | unknown => active for EPR present with corresponding decision,
inactive as soon as patient changes/withdraws decision, unknown if no EPR exists. Binding: ConsentState (required): Indicates the state of the consent. | ||||
![]() ![]() |
SΣ | 1..* | CodeableConcept | Initial classification of consent, used with provision.code to identify consent types. Binding: ConsentCategoriesVS (required) | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: IDSCL | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Patient) | The patient to whom this consent applies to. | ||||
![]() ![]() |
SΣ | 1..1 | date | Respresents the date when the entry to the system was made. | ||||
![]() ![]() |
SΣ | 1..1 | Period | Effective period for this Consent | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Patient | RelatedPerson | Organization) | Person who has given or denied consent. Generally either patient or legal representative. | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | Either Patient or RelatedPerson. Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Either Patient ID or RelatedPerson ID. Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
SΣ | 1..1 | Reference(Organization) | Organization that must follow the instructions of the Consent or is granted rights. | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
SΣ | 1..1 | uri | Organization Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). Required Pattern: Organization | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | UID of the Organization. Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name of the Organization as defined in the referenced resource. | ||||
![]() ![]() |
S | 1..1 | Reference(HealthcareService) | Application that recorded/changed the consent. For instance a CIS or a Patientportal. | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Name of the Application as defined in the referenced resource. Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name of the Application as defined in the referenced resource. | ||||
![]() ![]() |
S | 1..1 | Reference(Organization) | Organization to which the Consent applies. | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
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 | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | uri | urn:oid Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | UID of the Organization. Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
SΣC | 1..1 | string | Name of the Organization as defined in the referenced resource. | ||||
![]() ![]() |
0..* | Attachment | Source from which this consent is taken | |||||
![]() ![]() |
0..* | Reference(Consent | DocumentReference | Contract | QuestionnaireResponse) | Source from which this consent is taken | |||||
![]() ![]() |
0..* | CodeableConcept | Regulations establishing base Consent Binding: ConsentPolicyRuleCodes (example): Regulatory policy examples | |||||
![]() ![]() |
0..1 | BackboneElement | Computable version of the backing policy | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | Reference(Resource) | Reference backing policy resource | |||||
![]() ![]() ![]() |
0..1 | url | URL to a computable backing policy | |||||
![]() ![]() |
0..* | Reference(DocumentReference) | Human Readable Policy | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | Consent Verified by patient or family | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 1..1 | boolean | Has been verified | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Business case of verification Binding: ConsentVerificationCodes (example): Types of Verification/Validation. | |||||
![]() ![]() ![]() |
0..1 | Reference(Organization | Practitioner | PractitionerRole) | Person conducting verification | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient | RelatedPerson) | Person who verified | |||||
![]() ![]() ![]() |
0..* | dateTime | When consent verified | |||||
![]() ![]() |
?!SΣ | 0..1 | code | deny = EPD present | No decision if no EPR exists or status unknown.
When changed/withdrawn, the status changes to inactive, but the decision remains the same. 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. | ||||
![]() ![]() |
SΣ | 1..* | BackboneElement | Exeptions/Constraints to the base decision. | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for this provision | ||||
![]() ![]() ![]() |
0..* | BackboneElement | Who|what controlled by this provision (or group, by role) | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | How the actor is involved Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations. | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Actions controlled by this provision Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels that define affected resources Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc Binding: ConsentContentClass (preferred): The document type a consent provision covers. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | e.g. Resource Type, Profile, etc Binding: ResourceType (extensible): The resource types a consent provision covers. | ||||
![]() ![]() ![]() |
SΣ | 1..* | CodeableConcept | Additional classification of consent, used with category to identify consent types. Binding: ConsentProvisionCodesVS (required) | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/consentpolicycodes | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: ch-epr | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for data controlled by this provision | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | Data controlled by this provision | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. | ||||
![]() ![]() ![]() ![]() |
Σ | 1..1 | Reference(Resource) | The actual data reference | ||||
![]() ![]() ![]() |
0..1 | Expression | A computable expression of the consent | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Is only specified if restrictions are only to apply to a specific case/encounter,
e.g. case exclusion (Fallausschluss).
A separate provision.provision must be created for each case/encounter concerned. | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for this provision | ||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Who|what controlled by this provision (or group, by role) | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | How the actor is involved Binding: ParticipationRoleType (extensible): How an actor is involved in the consent considerations. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | Resource for the actor (or group, by role) | |||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Actions controlled by this provision Binding: ConsentActionCodes (example): Detailed codes for the consent action. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels that define affected resources Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | e.g. Resource Type, Profile, CDA, etc Binding: ConsentContentClass (preferred): The document type a consent provision covers. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | Coding | e.g. Resource Type, Profile, etc Binding: ResourceType (extensible): The resource types a consent provision covers. | ||||
![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Timeframe for data controlled by this provision | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | Data controlled by this provision | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | instance | related | dependents | authoredby Binding: ConsentDataMeaning (required): How a resource reference is interpreted when testing consent restrictions. Required Pattern: related | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(Encounter) | Encounter/Patientenfall for which an exception to the decision is to be made. | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..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). | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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. | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | string | Encounternumber/Patientenfallnummer of the respective Encounter. Example General: 123456 | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() ![]() |
0..1 | Expression | A computable expression of the consent | |||||
![]() ![]() ![]() ![]() |
0..* | See provision (Consent) | Nested Exception Provisions | |||||
Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| Consent.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| Consent.status | required | ConsentStatehttp://hl7.org/fhir/ValueSet/consent-state-codes|5.0.0From the FHIR Standard | |
| Consent.category | required | ConsentCategoriesVShttp://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentCategoriesVSFrom this IG | |
| Consent.grantor.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.grantor.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.grantor.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Consent.grantee.type | extensible | Pattern Value: Organizationhttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.grantee.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.grantee.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Consent.manager.type | extensible | Pattern Value: HealthcareServicehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.manager.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.manager.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Consent.controller.type | extensible | Pattern Value: Organizationhttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.controller.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.controller.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard | |
| Consent.regulatoryBasis | example | ConsentPolicyRuleCodeshttp://hl7.org/fhir/ValueSet/consent-policyFrom the FHIR Standard | |
| Consent.verification.verificationType | example | ConsentVerificationCodeshttp://hl7.org/fhir/ValueSet/consent-verificationFrom the FHIR Standard | |
| Consent.decision | required | ConsentProvisionTypehttp://hl7.org/fhir/ValueSet/consent-provision-type|5.0.0From the FHIR Standard | |
| Consent.provision.actor.role | extensible | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-typeFrom the FHIR Standard | |
| Consent.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-actionFrom the FHIR Standard | |
| Consent.provision.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examplesFrom the FHIR Standard | |
| Consent.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | |
| Consent.provision.documentType | preferred | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classFrom the FHIR Standard | |
| Consent.provision.resourceType | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.provision.code | required | ConsentProvisionCodesVShttp://fhir.kisimdocs.ch/ig/KisimConsent/ValueSet/ConsentProvisionCodesVSFrom this IG | |
| Consent.provision.data.meaning | required | ConsentDataMeaninghttp://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0From the FHIR Standard | |
| Consent.provision.provision.actor.role | extensible | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-typeFrom the FHIR Standard | |
| Consent.provision.provision.action | example | ConsentActionCodeshttp://hl7.org/fhir/ValueSet/consent-actionFrom the FHIR Standard | |
| Consent.provision.provision.securityLabel | example | SecurityLabelExampleshttp://hl7.org/fhir/ValueSet/security-label-examplesFrom the FHIR Standard | |
| Consent.provision.provision.purpose | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | |
| Consent.provision.provision.documentType | preferred | ConsentContentClasshttp://hl7.org/fhir/ValueSet/consent-content-classFrom the FHIR Standard | |
| Consent.provision.provision.resourceType | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.provision.provision.code | example | ConsentContentCodeshttp://hl7.org/fhir/ValueSet/consent-content-codeFrom the FHIR Standard | |
| Consent.provision.provision.data.meaning | required | Pattern Value: relatedhttp://hl7.org/fhir/ValueSet/consent-data-meaning|5.0.0From the FHIR Standard | |
| Consent.provision.provision.data.reference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard | |
| Consent.provision.provision.data.reference.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0From the FHIR Standard | |
| Consent.provision.provision.data.reference.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard |
| 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
Other representations of profile: CSV, Excel, Schematron