Cross Border Data Exchange IG
1.0.0 - CI Build International flag

Cross Border Data Exchange IG, published by IEHR-Workgroup. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/InteropEHRate-project/cross-border-data-exchange/ and changes regularly. See the Directory of published versions

Resource Profile: ConsentApproval - IEHR

Official URL: http://interopehrate.eu/fhir/StructureDefinition/ConsentApproval-IEHR Version: 1.0.0
Draft as of 2024-04-08 Computable Name: ConsentApprovalIEHR

Usage:

Formal Views of Profile Content

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

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance C 0..* Provenance Who, What, When for a set of resources
provIEHR-1: The Author SHALL BE the same as the Signer (Signature.who)
... target S 1..1 Reference(Consent-IEHR) Target Reference(s) (usually version specific)
... agent S 1..1 BackboneElement Actor involved
.... type S 1..1 CodeableConcept How the agent participated
Fixed Value: As shown
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
...... display 1..1 string Representation defined by the system
Fixed Value: Author
.... who S 1..1 Reference(Patient-IEHR) Who participated
... signature S 1..1 ConsentApprovalSignatureIEHR A Signature - XML DigSig, JWS, Graphical image of signature, etc.

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
provIEHR-1errorProvenanceThe Author SHALL BE the same as the Signer (Signature.who)
: agent.where(type.coding.code='author').first().who= signature.who
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance C 0..* Provenance Who, What, When for a set of resources
provIEHR-1: The Author SHALL BE the same as the Signer (Signature.who)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..1 Reference(Consent-IEHR) Target Reference(s) (usually version specific)
... agent S 1..1 BackboneElement Actor involved
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Fixed Value: As shown
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
...... display 1..1 string Representation defined by the system
Fixed Value: Author
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... text 0..0 string Plain text representation of the concept
.... who SΣ 1..1 Reference(Patient-IEHR) Who participated
... signature S 1..1 ConsentApprovalSignatureIEHR A Signature - XML DigSig, JWS, Graphical image of signature, etc.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.agent.typeextensibleFixed Value: author("Author")
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenanceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorProvenanceIf 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-5errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
provIEHR-1errorProvenanceThe Author SHALL BE the same as the Signer (Signature.who)
: agent.where(type.coding.code='author').first().who= signature.who
NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance C 0..* Provenance Who, What, When for a set of resources
provIEHR-1: The Author SHALL BE the same as the Signer (Signature.who)
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..1 Reference(Consent-IEHR) Target Reference(s) (usually version specific)
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded Σ 1..1 instant When the activity was recorded / updated
... policy 0..* uri Policy or plan the activity was defined by
... location 0..1 Reference(Location) Where the activity occurred, if relevant
... reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


... activity 0..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... agent S 1..1 BackboneElement Actor involved
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Fixed Value: As shown
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
...... display 1..1 string Representation defined by the system
Fixed Value: Author
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... text 0..0 string Plain text representation of the concept
.... role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


.... who SΣ 1..1 Reference(Patient-IEHR) Who participated
.... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
... entity 0..* BackboneElement An entity used in this activity
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role Σ 1..1 code derivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.

.... what Σ 1..1 Reference(Resource) Identity of entity
.... agent 0..* See agent (Provenance) Entity is attributed to this agent
... signature S 1..1 ConsentApprovalSignatureIEHR A Signature - XML DigSig, JWS, Graphical image of signature, etc.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Provenance.reasonextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activityextensibleProvenanceActivityType
http://hl7.org/fhir/ValueSet/provenance-activity-type
from the FHIR Standard
Provenance.agent.typeextensibleFixed Value: author("Author")
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.entity.rolerequiredProvenanceEntityRole
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenanceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorProvenanceIf 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-5errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
provIEHR-1errorProvenanceThe Author SHALL BE the same as the Signer (Signature.who)
: agent.where(type.coding.code='author').first().who= signature.who

Differential View

This structure is derived from Provenance

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance C 0..* Provenance Who, What, When for a set of resources
provIEHR-1: The Author SHALL BE the same as the Signer (Signature.who)
... target S 1..1 Reference(Consent-IEHR) Target Reference(s) (usually version specific)
... agent S 1..1 BackboneElement Actor involved
.... type S 1..1 CodeableConcept How the agent participated
Fixed Value: As shown
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
...... display 1..1 string Representation defined by the system
Fixed Value: Author
.... who S 1..1 Reference(Patient-IEHR) Who participated
... signature S 1..1 ConsentApprovalSignatureIEHR A Signature - XML DigSig, JWS, Graphical image of signature, etc.

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
provIEHR-1errorProvenanceThe Author SHALL BE the same as the Signer (Signature.who)
: agent.where(type.coding.code='author').first().who= signature.who

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance C 0..* Provenance Who, What, When for a set of resources
provIEHR-1: The Author SHALL BE the same as the Signer (Signature.who)
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..1 Reference(Consent-IEHR) Target Reference(s) (usually version specific)
... agent S 1..1 BackboneElement Actor involved
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Fixed Value: As shown
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
...... display 1..1 string Representation defined by the system
Fixed Value: Author
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... text 0..0 string Plain text representation of the concept
.... who SΣ 1..1 Reference(Patient-IEHR) Who participated
... signature S 1..1 ConsentApprovalSignatureIEHR A Signature - XML DigSig, JWS, Graphical image of signature, etc.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.agent.typeextensibleFixed Value: author("Author")
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenanceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorProvenanceIf 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-5errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
provIEHR-1errorProvenanceThe Author SHALL BE the same as the Signer (Signature.who)
: agent.where(type.coding.code='author').first().who= signature.who

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Provenance C 0..* Provenance Who, What, When for a set of resources
provIEHR-1: The Author SHALL BE the same as the Signer (Signature.who)
... 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... target SΣ 1..1 Reference(Consent-IEHR) Target Reference(s) (usually version specific)
... occurred[x] 0..1 When the activity occurred
.... occurredPeriod Period
.... occurredDateTime dateTime
... recorded Σ 1..1 instant When the activity was recorded / updated
... policy 0..* uri Policy or plan the activity was defined by
... location 0..1 Reference(Location) Where the activity occurred, if relevant
... reason 0..* CodeableConcept Reason the activity is occurring
Binding: PurposeOfUse (extensible): The reason the activity took place.


... activity 0..1 CodeableConcept Activity that occurred
Binding: ProvenanceActivityType (extensible): The activity that took place.

... agent S 1..1 BackboneElement Actor involved
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type SΣ 1..1 CodeableConcept How the agent participated
Binding: ProvenanceParticipantType (extensible): The type of participation that a provenance agent played with respect to the activity.


Fixed Value: As shown
..... id 0..0 string Unique id for inter-element referencing
..... extension 0..0 Extension Additional content defined by implementations
..... coding 1..1 Coding Code defined by a terminology system
Fixed Value: (complex)
...... id 0..0 string Unique id for inter-element referencing
...... extension 0..0 Extension Additional content defined by implementations
...... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/provenance-participant-type
...... version 0..0 string Version of the system - if relevant
...... code 1..1 code Symbol in syntax defined by the system
Fixed Value: author
...... display 1..1 string Representation defined by the system
Fixed Value: Author
...... userSelected 0..0 boolean If this coding was chosen directly by the user
..... text 0..0 string Plain text representation of the concept
.... role 0..* CodeableConcept What the agents role was
Binding: SecurityRoleType (example): The role that a provenance agent played with respect to the activity.


.... who SΣ 1..1 Reference(Patient-IEHR) Who participated
.... onBehalfOf 0..1 Reference(Practitioner | PractitionerRole | RelatedPerson | Patient | Device | Organization) Who the agent is representing
... entity 0..* BackboneElement An entity used in this activity
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... role Σ 1..1 code derivation | revision | quotation | source | removal
Binding: ProvenanceEntityRole (required): How an entity was used in an activity.

.... what Σ 1..1 Reference(Resource) Identity of entity
.... agent 0..* See agent (Provenance) Entity is attributed to this agent
... signature S 1..1 ConsentApprovalSignatureIEHR A Signature - XML DigSig, JWS, Graphical image of signature, etc.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Provenance.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Provenance.reasonextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
Provenance.activityextensibleProvenanceActivityType
http://hl7.org/fhir/ValueSet/provenance-activity-type
from the FHIR Standard
Provenance.agent.typeextensibleFixed Value: author("Author")
http://hl7.org/fhir/ValueSet/provenance-agent-type
from the FHIR Standard
Provenance.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
Provenance.entity.rolerequiredProvenanceEntityRole
http://hl7.org/fhir/ValueSet/provenance-entity-role|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorProvenanceIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorProvenanceIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorProvenanceIf 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-5errorProvenanceIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceProvenanceA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
provIEHR-1errorProvenanceThe Author SHALL BE the same as the Signer (Signature.who)
: agent.where(type.coding.code='author').first().who= signature.who

 

Other representations of profile: CSV, Excel, Schematron