Guía implementación interoperabilidad FHIR sectorial e intersectorial
0.14.0 - ci-build

Guía implementación interoperabilidad FHIR sectorial e intersectorial - Local Development build (v0.14.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: HCEU - Donator or Not Donator Consent

Defining URL:https://ohapi-fhir-dev-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-ProfileDonatorConsentHCEU
Version:0.14.0
Name:ProfileDonatorConsentHCEU
Title:HCEU - Donator or Not Donator Consent
Status:Draft as of 2025-08-04 20:23:02-0500
Definition:

Recurso que permite registrar la oposición o voluntad anticipada de una persona de ser donante de organos y tejidos

Publisher:minsait - An Indra Company. Secretaría de Salud de Bogotá,
Copyright:

Secretaría de Salud de Bogotá

Source Resource:XML / JSON / Turtle

La URL oficial para este perfil es: 

https://ohapi-fhir-dev-service-fhir-project.apps.indraclusterdes.eastus.aroapp.io/StructureDefinition-ProfileDonatorConsentHCEU

Vistas formales para el perfil

Descripción de perfiles, diferenciales, resumenes y cómo deben ser las representaciones en XML y JSON.

Esta estructura se deriva de Consent

Summary

Mandatory: 25 elements
Must-Support: 1 element
Fixed: 9 elements
Prohibited: 26 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Consent.identifier

Esta estructura se deriva de Consent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent Consent
... Slices for identifier S 1..* Identifier Identifier for this record (external references)
Slice: Unordered, Open by pattern:use
.... identifier:HISdentifier 1..1 Identifier Identifier for this record (external references)
..... use 1..1 code usual | official | temp | secondary | old (If known)
Fixed Value: usual
..... type 0..0
..... system 1..1 uri The namespace for the identifier value
Example HIS uri: http://hospitalSystemInformation.example.org/Consents/
..... value 1..1 string The value that is unique
..... period 0..0
..... assigner 0..0
... status 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Fixed Value: active
... scope
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: adr
..... display 1..1 string Representation defined by the system
Fixed Value: Advanced Care Directive
.... text 0..0
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: acd
..... display 1..1 string Representation defined by the system
Fixed Value: Advance Directive
.... text 0..0
... patient 1..1 Reference(HCEU - Patient) Who the consent applies to
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... type 0..0
.... identifier 0..0
... dateTime 1..1 dateTime When this Consent was created or indexed
... performer 0..0
... organization 1..1 Reference(HCEU - Organization) Custodian of the consent
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... type 0..0
.... identifier 0..0
... source[x] 0..0
... policy 0..0
... policyRule 0..0
... verification 0..0
... provision 1..1 BackboneElement Constraints to the base Consent.policyRule
.... id 0..0
.... type 1..1 code deny | permit
.... period 0..0
.... actor 0..0
.... action 1..1 CodeableConcept Actions controlled by this rule
Binding: https://oh-modules.apps.indraclusterdes.eastus.aroapp.io/ehrserver/fhir/CodeSystem/TipoConsentimientoDonante (required): Tipo de consentimiento de donante.
..... coding 1..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://oh-modules.apps.indraclusterdes.eastus.aroapp.io/ehrserver/fhir/CodeSystem/TipoConsentimientoDonante
...... version 0..0
...... code 1..1 code Symbol in syntax defined by the system
...... display 1..1 string Representation defined by the system
..... text 0..0
.... securityLabel 0..0
.... purpose 0..0
.... class 0..0
.... code 0..0
.... dataPeriod 0..0
.... data 0..0
.... provision 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* Consent A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
... 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
... Slices for identifier SΣ 1..* Identifier Identifier for this record (external references)
Slice: Unordered, Open by pattern:use

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
.... identifier:HISdentifier Σ 1..1 Identifier Identifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example HIS uri: http://hospitalSystemInformation.example.org/Consents/
..... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Fixed Value: active
... scope ?!Σ 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: adr
..... display Σ 1..1 string Representation defined by the system
Fixed Value: Advanced Care Directive
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... category Σ 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: acd
..... display Σ 1..1 string Representation defined by the system
Fixed Value: Advance Directive
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... patient Σ 1..1 Reference(HCEU - Patient) Who the consent applies to
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... display Σ 0..1 string Text alternative for the resource
... dateTime Σ 1..1 dateTime When this Consent was created or indexed
... organization Σ 1..1 Reference(HCEU - Organization) Custodian of the consent
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... display Σ 0..1 string Text alternative for the resource
... provision Σ 1..1 BackboneElement Constraints to the base Consent.policyRule
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 1..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
.... action Σ 1..1 CodeableConcept Actions controlled by this rule
Binding: https://oh-modules.apps.indraclusterdes.eastus.aroapp.io/ehrserver/fhir/CodeSystem/TipoConsentimientoDonante (required): Tipo de consentimiento de donante.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://oh-modules.apps.indraclusterdes.eastus.aroapp.io/ehrserver/fhir/CodeSystem/TipoConsentimientoDonante
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent 0..* Consent A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
... identifier Σ 1..* Identifier Identifier for this record (external references)
Slice: Unordered, Open by pattern:use

doco Documentation for this format

Esta estructura se deriva de Consent

Summary

Mandatory: 25 elements
Must-Support: 1 element
Fixed: 9 elements
Prohibited: 26 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of Consent.identifier

Vista de diferencias

Esta estructura se deriva de Consent

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent Consent
... Slices for identifier S 1..* Identifier Identifier for this record (external references)
Slice: Unordered, Open by pattern:use
.... identifier:HISdentifier 1..1 Identifier Identifier for this record (external references)
..... use 1..1 code usual | official | temp | secondary | old (If known)
Fixed Value: usual
..... type 0..0
..... system 1..1 uri The namespace for the identifier value
Example HIS uri: http://hospitalSystemInformation.example.org/Consents/
..... value 1..1 string The value that is unique
..... period 0..0
..... assigner 0..0
... status 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Fixed Value: active
... scope
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: adr
..... display 1..1 string Representation defined by the system
Fixed Value: Advanced Care Directive
.... text 0..0
.... coding 1..1 Coding Code defined by a terminology system
..... system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
..... code 1..1 code Symbol in syntax defined by the system
Fixed Value: acd
..... display 1..1 string Representation defined by the system
Fixed Value: Advance Directive
.... text 0..0
... patient 1..1 Reference(HCEU - Patient) Who the consent applies to
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... type 0..0
.... identifier 0..0
... dateTime 1..1 dateTime When this Consent was created or indexed
... performer 0..0
... organization 1..1 Reference(HCEU - Organization) Custodian of the consent
.... reference 1..1 string Literal reference, Relative, internal or absolute URL
.... type 0..0
.... identifier 0..0
... source[x] 0..0
... policy 0..0
... policyRule 0..0
... verification 0..0
... provision 1..1 BackboneElement Constraints to the base Consent.policyRule
.... id 0..0
.... type 1..1 code deny | permit
.... period 0..0
.... actor 0..0
.... action 1..1 CodeableConcept Actions controlled by this rule
Binding: https://oh-modules.apps.indraclusterdes.eastus.aroapp.io/ehrserver/fhir/CodeSystem/TipoConsentimientoDonante (required): Tipo de consentimiento de donante.
..... coding 1..1 Coding Code defined by a terminology system
...... system 1..1 uri Identity of the terminology system
Fixed Value: https://oh-modules.apps.indraclusterdes.eastus.aroapp.io/ehrserver/fhir/CodeSystem/TipoConsentimientoDonante
...... version 0..0
...... code 1..1 code Symbol in syntax defined by the system
...... display 1..1 string Representation defined by the system
..... text 0..0
.... securityLabel 0..0
.... purpose 0..0
.... class 0..0
.... code 0..0
.... dataPeriod 0..0
.... data 0..0
.... provision 0..0

doco Documentation for this format

Tabla de resumen

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Consent C 0..* Consent A healthcare consumer's choices to permit or deny recipients or roles to perform actions for specific purposes and periods of time
Constraints: ppc-1, ppc-2, ppc-3, ppc-4, ppc-5
... 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
... Slices for identifier SΣ 1..* Identifier Identifier for this record (external references)
Slice: Unordered, Open by pattern:use

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
.... identifier:HISdentifier Σ 1..1 Identifier Identifier for this record (external references)

Example General: {"system":"http://acme.org/identifier/local/eCMS","value":"Local eCMS identifier"}
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 1..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
Fixed Value: usual
..... system Σ 1..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
Example HIS uri: http://hospitalSystemInformation.example.org/Consents/
..... value Σ 1..1 string The value that is unique
Example General: 123456
... status ?!Σ 1..1 code draft | proposed | active | rejected | inactive | entered-in-error
Binding: ConsentState (required): Indicates the state of the consent.
Fixed Value: active
... scope ?!Σ 1..1 CodeableConcept Which of the four areas this resource covers (extensible)
Binding: ConsentScopeCodes (extensible): The four anticipated uses for the Consent Resource.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: adr
..... display Σ 1..1 string Representation defined by the system
Fixed Value: Advanced Care Directive
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... category Σ 1..* CodeableConcept Classification of the consent statement - for indexing/retrieval
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding Σ 1..1 Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system Σ 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/consentscope
..... version Σ 0..1 string Version of the system - if relevant
..... code Σ 1..1 code Symbol in syntax defined by the system
Fixed Value: acd
..... display Σ 1..1 string Representation defined by the system
Fixed Value: Advance Directive
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
... patient Σ 1..1 Reference(HCEU - Patient) Who the consent applies to
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... display Σ 0..1 string Text alternative for the resource
... dateTime Σ 1..1 dateTime When this Consent was created or indexed
... organization Σ 1..1 Reference(HCEU - Organization) Custodian of the consent
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... display Σ 0..1 string Text alternative for the resource
... provision Σ 1..1 BackboneElement Constraints to the base Consent.policyRule
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... type Σ 1..1 code deny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.
.... action Σ 1..1 CodeableConcept Actions controlled by this rule
Binding: https://oh-modules.apps.indraclusterdes.eastus.aroapp.io/ehrserver/fhir/CodeSystem/TipoConsentimientoDonante (required): Tipo de consentimiento de donante.
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... coding Σ 1..1 Coding Code defined by a terminology system
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 1..1 uri Identity of the terminology system
Fixed Value: https://oh-modules.apps.indraclusterdes.eastus.aroapp.io/ehrserver/fhir/CodeSystem/TipoConsentimientoDonante
...... code Σ 1..1 code Symbol in syntax defined by the system
...... display Σ 1..1 string Representation defined by the system
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user

doco Documentation for this format

 

Otras representaciones de este perfil: Schematron

Terminology Bindings

PathConformanceValueSet / CodeURI
Consent.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
From the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
Consent.identifier:HISdentifier.userequiredFixed Value: usual
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
From the FHIR Standard
Consent.statusrequiredFixed Value: active
http://hl7.org/fhir/ValueSet/consent-state-codes|4.0.1
From the FHIR Standard
Consent.scopeextensibleConsentScopeCodes
http://hl7.org/fhir/ValueSet/consent-scope
From the FHIR Standard
Consent.categoryextensibleConsentCategoryCodes
http://hl7.org/fhir/ValueSet/consent-category
From the FHIR Standard
Consent.provision.typerequiredConsentProvisionType
http://hl7.org/fhir/ValueSet/consent-provision-type|4.0.1
From the FHIR Standard
Consent.provision.actor.roleextensibleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
From the FHIR Standard
Consent.provision.actionrequiredhttps://oh-modules.apps.indraclusterdes.eastus.aroapp.io/ehrserver/fhir/CodeSystem/TipoConsentimientoDonante
https://oh-modules.apps.indraclusterdes.eastus.aroapp.io/ehrserver/fhir/CodeSystem/TipoConsentimientoDonante
Consent.provision.data.meaningrequiredConsentDataMeaning
http://hl7.org/fhir/ValueSet/consent-data-meaning|4.0.1
From the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorConsentIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorConsentIf 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-4errorConsentIf 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-5errorConsentIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceConsentA 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()
ppc-1errorConsentEither a Policy or PolicyRule
: policy.exists() or policyRule.exists()
ppc-2errorConsentIF Scope=privacy, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='patient-privacy').exists().not()
ppc-3errorConsentIF Scope=research, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='research').exists().not()
ppc-4errorConsentIF Scope=adr, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='adr').exists().not()
ppc-5errorConsentIF Scope=treatment, there must be a patient
: patient.exists() or scope.coding.where(system='something' and code='treatment').exists().not()