Guía MHD para el Intercambio de Información de Salud en Chile
0.1.0 - ci-build
Guía MHD para el Intercambio de Información de Salud en Chile, published by Hl7 Chile. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7Chile/MHD-CL/ and changes regularly. See the Directory of published versions
| Official URL: https://hl7chile.cl/fhir/ig/mhd/StructureDefinition/ReferenciaDocumental | Version: 0.1.0 | |||
| Draft as of 2026-10-23 | Computable Name: ReferenciaDocumental | |||
| Other Identifiers: OID:2.16.840.1.113883.2.22.40.14.42.3 | ||||
Perfil asociado al la refetrencia documental para HSI en un modelo MHD, consderado para transacciones asociadas a una ITI-65 e ITI-67. Se considera en el perfil la asociación de documentos de tipo IPS, referenciados a la Guía Core Argentna AR.FHIR.CORE
El perfil ReferenciaDocumental se utiliza para registrar los metadatos de un documento clínico y señalar dónde puede recuperarse su contenido. Está derivado de MinimalDocumentReference de IHE MHD y está pensado para escenarios de publicación, búsqueda y recuperación documental relacionados con las transacciones ITI-65, ITI-67 e ITI-68.
El recurso DocumentReference no es necesariamente el documento clínico. Es principalmente un índice o registro de metadatos que permite:
content.attachment.url;content.attachment.hash.En este perfil, el contenido se maneja por referencia: el documento no se incorpora codificado dentro del DocumentReference, sino que se obtiene desde la ubicación indicada en attachment.url.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MinimalDocumentReference | A reference to a document | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() |
0..1 | oid | The homeCommunityId where the artifact resides URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-HomeCommunityId | |||||
![]() ![]() |
1..1 | UniqueIdIdentifier | Identificador único para el documento IPS nacional referenciado. Es el identificador principal del IPS Example Ejemplo de identificador maestro: {"system":"https://repositorio.cl/documentos/ips","value":"IPS-2026-00001"} | |||||
![]() ![]() |
0..* | Identifier | Identificador alternativo para el documento IPS nacional referenciado. Es un identificador secundario del IPS Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
0..1 | EntryUUIDIdentifier | Business identifier for the DocumentReference | |||||
![]() ![]() ![]() |
0..1 | UniqueIdIdentifier | Unique identifier for the referenced Document | |||||
![]() ![]() |
1..1 | code | Estado de la referencia al documento IPS: current|superseded|entered-in-error Binding: MHD DocumentReference status codes (required) | |||||
![]() ![]() |
1..1 | CodeableConcept | Tipo de documento referenciado Binding: Tipos de Documento Clínico para DocumentReference (extensible) | |||||
![]() ![]() |
1..1 | CodeableConcept | Categoría del documento referenciado Binding: Categorías de Documento Clínico para DocumentReference (extensible) | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Required Pattern: Resumen clínico de paciente (extensions allowed) | |||||
![]() ![]() |
1..1 | Reference(CL Paciente) | Paciente al que se refiere el documento IPS nacional referenciado | |||||
![]() ![]() |
1..1 | instant | Fecha de creación del documento IPS nacional referenciado | |||||
![]() ![]() |
1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Autor del documento o IPS nacional referenciado | |||||
![]() ![]() |
0..* | BackboneElement | Relationships to other documents | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
![]() ![]() ![]() |
1..1 | Reference(DocumentReference) | Target of the relationship | |||||
![]() ![]() |
0..* | CodeableConcept | Etiqueta de seguridad del documento IPS nacional referenciado Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() |
1..1 | BackboneElement | Contenido del documento (IPS u otro) nacional referenciado con url reltiva en caso de ser X-Road, o url absoluta en caso de ser un repositorio FHIR. Se define como un campo obligatorio, y se recomienda usar el valor 'Attachment' para indicar que el contenido del documento referenciado es un archivo adjunto que contiene el documento clínico en formato digital. | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | Attachment | Definición del archivo adjunto que contiene el documento referenciado | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/fhir+json (extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | |||||
![]() ![]() ![]() ![]() |
1..1 | url | URL del archivo adjunto que contiene el documento referenciado, en formato FHIR IPS, Binary IPS u otro documnento en esos formatos. Example General: http://www.acme.com/logo-small.png Example Ejemplo de IPS referenciado en X-Road: /pba/tndXroad/santamarina/docs/ips-xxx | |||||
![]() ![]() ![]() ![]() |
0..1 | base64Binary | Hash del archivo adjunto que contiene el documento IPS nacional referenciado | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Título del archivo adjunto que contiene el documento referenciado Example General: Official Corporate Logo Example Ejemplo de Título del documento contenido referenciado via X-Road: IPS-001 | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Date attachment was first created | |||||
![]() ![]() ![]() |
0..1 | Coding | Format/content rules for the document Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred) | |||||
![]() ![]() |
1..1 | BackboneElement | Contexto del documento IPS nacional u otro referenciado | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | Period | Periodo de tiempo al que se refiere el documento IPS nacional u otro referenciado | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.status | Base | required | MHD DocumentReference status codes | 📦4.2.5 | Mobile access to Health Documents v4.2 |
| DocumentReference.type | Base | extensible | Tipos de Documento Clínico para DocumentReference | 📦0.1.0 | This IG |
| DocumentReference.category | Base | extensible | Categorías de Documento Clínico para DocumentReference | 📦0.1.0 | This IG |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.format | Base | preferred | IHE ValueSet of Format Codes for use with Document Sharing | 📦1.6.0 | IHE FormatCode Vocabulary v1.6 |
| DocumentReference.context.facilityType | Base | example | Facility Type Code Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.practiceSetting | Base | example | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DocumentReference | 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 MinimalDocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
MinimalDocumentReference | |||
![]() ![]() |
1..1 | UniqueIdIdentifier | Identificador único para el documento IPS nacional referenciado. Es el identificador principal del IPS Example Ejemplo de identificador maestro: {"system":"https://repositorio.cl/documentos/ips","value":"IPS-2026-00001"} | |
![]() ![]() |
0..* | Identifier | Identificador alternativo para el documento IPS nacional referenciado. Es un identificador secundario del IPS | |
![]() ![]() |
1..1 | code | Estado de la referencia al documento IPS: current|superseded|entered-in-error | |
![]() ![]() |
1..1 | CodeableConcept | Tipo de documento referenciado Binding: Tipos de Documento Clínico para DocumentReference (extensible) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Example Para IPS: http://loinc.org | |
![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Example Código Loinc para IPS: 34133-9 | |
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Example El display asociado: Summary of episode note | |
![]() ![]() |
1..1 | CodeableConcept | Categoría del documento referenciado Binding: Categorías de Documento Clínico para DocumentReference (extensible) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Example Para IPS: http://loinc.org | |
![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Example Loinc Asociado: 60591-5 | |
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Example Display asociado al código Loinc: Patient summary Document | |
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Required Pattern: Resumen clínico de paciente (extensions allowed) | |
![]() ![]() |
1..1 | Reference(CL Paciente) | Paciente al que se refiere el documento IPS nacional referenciado | |
![]() ![]() |
1..1 | instant | Fecha de creación del documento IPS nacional referenciado | |
![]() ![]() |
1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Autor del documento o IPS nacional referenciado | |
![]() ![]() |
0..* | CodeableConcept | Etiqueta de seguridad del documento IPS nacional referenciado | |
![]() ![]() |
1..1 | BackboneElement | Contenido del documento (IPS u otro) nacional referenciado con url reltiva en caso de ser X-Road, o url absoluta en caso de ser un repositorio FHIR. Se define como un campo obligatorio, y se recomienda usar el valor 'Attachment' para indicar que el contenido del documento referenciado es un archivo adjunto que contiene el documento clínico en formato digital. | |
![]() ![]() ![]() |
1..1 | Attachment | Definición del archivo adjunto que contiene el documento referenciado | |
![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. Required Pattern: application/fhir+json (extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | url | URL del archivo adjunto que contiene el documento referenciado, en formato FHIR IPS, Binary IPS u otro documnento en esos formatos. Example Ejemplo de IPS referenciado en X-Road: /pba/tndXroad/santamarina/docs/ips-xxx | |
![]() ![]() ![]() ![]() |
0..1 | base64Binary | Hash del archivo adjunto que contiene el documento IPS nacional referenciado | |
![]() ![]() ![]() ![]() |
0..1 | string | Título del archivo adjunto que contiene el documento referenciado Example Ejemplo de Título del documento contenido referenciado via X-Road: IPS-001 | |
![]() ![]() |
1..1 | BackboneElement | Contexto del documento IPS nacional u otro referenciado | |
![]() ![]() ![]() |
0..1 | Period | Periodo de tiempo al que se refiere el documento IPS nacional u otro referenciado | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.type | Base | extensible | Tipos de Documento Clínico para DocumentReference | 📦0.1.0 | This IG |
| DocumentReference.category | Base | extensible | Categorías de Documento Clínico para DocumentReference | 📦0.1.0 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MinimalDocumentReference | A reference to a document | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | id | Version specific identifier | |||||
![]() ![]() ![]() |
0..1 | instant | When the resource version last changed | |||||
![]() ![]() ![]() |
0..1 | uri | Identifies where the resource comes from | |||||
![]() ![]() ![]() |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() ![]() |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | oid | The homeCommunityId where the artifact resides URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-HomeCommunityId | |||||
![]() ![]() |
1..1 | UniqueIdIdentifier | Identificador único para el documento IPS nacional referenciado. Es el identificador principal del IPS Example Ejemplo de identificador maestro: {"system":"https://repositorio.cl/documentos/ips","value":"IPS-2026-00001"} | |||||
![]() ![]() |
0..* | Identifier | Identificador alternativo para el documento IPS nacional referenciado. Es un identificador secundario del IPS Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
0..1 | EntryUUIDIdentifier | Business identifier for the DocumentReference | |||||
![]() ![]() ![]() |
0..1 | UniqueIdIdentifier | Unique identifier for the referenced Document | |||||
![]() ![]() |
1..1 | code | Estado de la referencia al documento IPS: current|superseded|entered-in-error Binding: MHD DocumentReference status codes (required) | |||||
![]() ![]() |
1..1 | CodeableConcept | Tipo de documento referenciado Binding: Tipos de Documento Clínico para DocumentReference (extensible) | |||||
![]() ![]() ![]() |
0..1 | string | 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 | string | 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 Example Para IPS: http://loinc.org | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Example Código Loinc para IPS: 34133-9 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Example El display asociado: Summary of episode note | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
1..1 | CodeableConcept | Categoría del documento referenciado Binding: Categorías de Documento Clínico para DocumentReference (extensible) | |||||
![]() ![]() ![]() |
0..1 | string | 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 | string | 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 Example Para IPS: http://loinc.org | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Example Loinc Asociado: 60591-5 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Example Display asociado al código Loinc: Patient summary Document | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Required Pattern: Resumen clínico de paciente (extensions allowed) | |||||
![]() ![]() |
1..1 | Reference(CL Paciente) | Paciente al que se refiere el documento IPS nacional referenciado | |||||
![]() ![]() |
1..1 | instant | Fecha de creación del documento IPS nacional referenciado | |||||
![]() ![]() |
1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Autor del documento o IPS nacional referenciado | |||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
![]() ![]() |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
![]() ![]() |
0..* | BackboneElement | Relationships to other documents | |||||
![]() ![]() ![]() |
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 | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
![]() ![]() ![]() |
1..1 | Reference(DocumentReference) | Target of the relationship | |||||
![]() ![]() |
0..1 | string | Human-readable description | |||||
![]() ![]() |
0..* | CodeableConcept | Etiqueta de seguridad del documento IPS nacional referenciado Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() |
1..1 | BackboneElement | Contenido del documento (IPS u otro) nacional referenciado con url reltiva en caso de ser X-Road, o url absoluta en caso de ser un repositorio FHIR. Se define como un campo obligatorio, y se recomienda usar el valor 'Attachment' para indicar que el contenido del documento referenciado es un archivo adjunto que contiene el documento clínico en formato digital. | |||||
![]() ![]() ![]() |
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 | Attachment | Definición del archivo adjunto que contiene el documento referenciado | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/fhir+json (extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | |||||
![]() ![]() ![]() ![]() |
1..1 | url | URL del archivo adjunto que contiene el documento referenciado, en formato FHIR IPS, Binary IPS u otro documnento en esos formatos. Example General: http://www.acme.com/logo-small.png Example Ejemplo de IPS referenciado en X-Road: /pba/tndXroad/santamarina/docs/ips-xxx | |||||
![]() ![]() ![]() ![]() |
0..1 | unsignedInt | Number of bytes of content (if url provided) | |||||
![]() ![]() ![]() ![]() |
0..1 | base64Binary | Hash del archivo adjunto que contiene el documento IPS nacional referenciado | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Título del archivo adjunto que contiene el documento referenciado Example General: Official Corporate Logo Example Ejemplo de Título del documento contenido referenciado via X-Road: IPS-001 | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Date attachment was first created | |||||
![]() ![]() ![]() |
0..1 | Coding | Format/content rules for the document Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred) | |||||
![]() ![]() |
1..1 | BackboneElement | Contexto del documento IPS nacional u otro referenciado | |||||
![]() ![]() ![]() |
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..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() |
0..1 | Period | Periodo de tiempo al que se refiere el documento IPS nacional u otro referenciado | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
![]() ![]() ![]() ![]() |
0..1 | string | 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") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| DocumentReference.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.status | Base | required | MHD DocumentReference status codes | 📦4.2.5 | Mobile access to Health Documents v4.2 |
| DocumentReference.type | Base | extensible | Tipos de Documento Clínico para DocumentReference | 📦0.1.0 | This IG |
| DocumentReference.category | Base | extensible | Categorías de Documento Clínico para DocumentReference | 📦0.1.0 | This IG |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.format | Base | preferred | IHE ValueSet of Format Codes for use with Document Sharing | 📦1.6.0 | IHE FormatCode Vocabulary v1.6 |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.4 |
| DocumentReference.context.facilityType | Base | example | Facility Type Code Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.practiceSetting | Base | example | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.sourcePatientInfo.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DocumentReference | 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 MinimalDocumentReference
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MinimalDocumentReference | A reference to a document | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() |
0..1 | oid | The homeCommunityId where the artifact resides URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-HomeCommunityId | |||||
![]() ![]() |
1..1 | UniqueIdIdentifier | Identificador único para el documento IPS nacional referenciado. Es el identificador principal del IPS Example Ejemplo de identificador maestro: {"system":"https://repositorio.cl/documentos/ips","value":"IPS-2026-00001"} | |||||
![]() ![]() |
0..* | Identifier | Identificador alternativo para el documento IPS nacional referenciado. Es un identificador secundario del IPS Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
0..1 | EntryUUIDIdentifier | Business identifier for the DocumentReference | |||||
![]() ![]() ![]() |
0..1 | UniqueIdIdentifier | Unique identifier for the referenced Document | |||||
![]() ![]() |
1..1 | code | Estado de la referencia al documento IPS: current|superseded|entered-in-error Binding: MHD DocumentReference status codes (required) | |||||
![]() ![]() |
1..1 | CodeableConcept | Tipo de documento referenciado Binding: Tipos de Documento Clínico para DocumentReference (extensible) | |||||
![]() ![]() |
1..1 | CodeableConcept | Categoría del documento referenciado Binding: Categorías de Documento Clínico para DocumentReference (extensible) | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Required Pattern: Resumen clínico de paciente (extensions allowed) | |||||
![]() ![]() |
1..1 | Reference(CL Paciente) | Paciente al que se refiere el documento IPS nacional referenciado | |||||
![]() ![]() |
1..1 | instant | Fecha de creación del documento IPS nacional referenciado | |||||
![]() ![]() |
1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Autor del documento o IPS nacional referenciado | |||||
![]() ![]() |
0..* | BackboneElement | Relationships to other documents | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
![]() ![]() ![]() |
1..1 | Reference(DocumentReference) | Target of the relationship | |||||
![]() ![]() |
0..* | CodeableConcept | Etiqueta de seguridad del documento IPS nacional referenciado Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() |
1..1 | BackboneElement | Contenido del documento (IPS u otro) nacional referenciado con url reltiva en caso de ser X-Road, o url absoluta en caso de ser un repositorio FHIR. Se define como un campo obligatorio, y se recomienda usar el valor 'Attachment' para indicar que el contenido del documento referenciado es un archivo adjunto que contiene el documento clínico en formato digital. | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
1..1 | Attachment | Definición del archivo adjunto que contiene el documento referenciado | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/fhir+json (extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | |||||
![]() ![]() ![]() ![]() |
1..1 | url | URL del archivo adjunto que contiene el documento referenciado, en formato FHIR IPS, Binary IPS u otro documnento en esos formatos. Example General: http://www.acme.com/logo-small.png Example Ejemplo de IPS referenciado en X-Road: /pba/tndXroad/santamarina/docs/ips-xxx | |||||
![]() ![]() ![]() ![]() |
0..1 | base64Binary | Hash del archivo adjunto que contiene el documento IPS nacional referenciado | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Título del archivo adjunto que contiene el documento referenciado Example General: Official Corporate Logo Example Ejemplo de Título del documento contenido referenciado via X-Road: IPS-001 | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Date attachment was first created | |||||
![]() ![]() ![]() |
0..1 | Coding | Format/content rules for the document Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred) | |||||
![]() ![]() |
1..1 | BackboneElement | Contexto del documento IPS nacional u otro referenciado | |||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||
![]() ![]() ![]() |
0..1 | Period | Periodo de tiempo al que se refiere el documento IPS nacional u otro referenciado | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.status | Base | required | MHD DocumentReference status codes | 📦4.2.5 | Mobile access to Health Documents v4.2 |
| DocumentReference.type | Base | extensible | Tipos de Documento Clínico para DocumentReference | 📦0.1.0 | This IG |
| DocumentReference.category | Base | extensible | Categorías de Documento Clínico para DocumentReference | 📦0.1.0 | This IG |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.format | Base | preferred | IHE ValueSet of Format Codes for use with Document Sharing | 📦1.6.0 | IHE FormatCode Vocabulary v1.6 |
| DocumentReference.context.facilityType | Base | example | Facility Type Code Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.practiceSetting | Base | example | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DocumentReference | 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 MinimalDocumentReference
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() |
|---|---|---|---|---|
![]() |
MinimalDocumentReference | |||
![]() ![]() |
1..1 | UniqueIdIdentifier | Identificador único para el documento IPS nacional referenciado. Es el identificador principal del IPS Example Ejemplo de identificador maestro: {"system":"https://repositorio.cl/documentos/ips","value":"IPS-2026-00001"} | |
![]() ![]() |
0..* | Identifier | Identificador alternativo para el documento IPS nacional referenciado. Es un identificador secundario del IPS | |
![]() ![]() |
1..1 | code | Estado de la referencia al documento IPS: current|superseded|entered-in-error | |
![]() ![]() |
1..1 | CodeableConcept | Tipo de documento referenciado Binding: Tipos de Documento Clínico para DocumentReference (extensible) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Example Para IPS: http://loinc.org | |
![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Example Código Loinc para IPS: 34133-9 | |
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Example El display asociado: Summary of episode note | |
![]() ![]() |
1..1 | CodeableConcept | Categoría del documento referenciado Binding: Categorías de Documento Clínico para DocumentReference (extensible) | |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..1 | uri | Identity of the terminology system Example Para IPS: http://loinc.org | |
![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Example Loinc Asociado: 60591-5 | |
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Example Display asociado al código Loinc: Patient summary Document | |
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Required Pattern: Resumen clínico de paciente (extensions allowed) | |
![]() ![]() |
1..1 | Reference(CL Paciente) | Paciente al que se refiere el documento IPS nacional referenciado | |
![]() ![]() |
1..1 | instant | Fecha de creación del documento IPS nacional referenciado | |
![]() ![]() |
1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Autor del documento o IPS nacional referenciado | |
![]() ![]() |
0..* | CodeableConcept | Etiqueta de seguridad del documento IPS nacional referenciado | |
![]() ![]() |
1..1 | BackboneElement | Contenido del documento (IPS u otro) nacional referenciado con url reltiva en caso de ser X-Road, o url absoluta en caso de ser un repositorio FHIR. Se define como un campo obligatorio, y se recomienda usar el valor 'Attachment' para indicar que el contenido del documento referenciado es un archivo adjunto que contiene el documento clínico en formato digital. | |
![]() ![]() ![]() |
1..1 | Attachment | Definición del archivo adjunto que contiene el documento referenciado | |
![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. Required Pattern: application/fhir+json (extensions allowed) | |
![]() ![]() ![]() ![]() |
1..1 | url | URL del archivo adjunto que contiene el documento referenciado, en formato FHIR IPS, Binary IPS u otro documnento en esos formatos. Example Ejemplo de IPS referenciado en X-Road: /pba/tndXroad/santamarina/docs/ips-xxx | |
![]() ![]() ![]() ![]() |
0..1 | base64Binary | Hash del archivo adjunto que contiene el documento IPS nacional referenciado | |
![]() ![]() ![]() ![]() |
0..1 | string | Título del archivo adjunto que contiene el documento referenciado Example Ejemplo de Título del documento contenido referenciado via X-Road: IPS-001 | |
![]() ![]() |
1..1 | BackboneElement | Contexto del documento IPS nacional u otro referenciado | |
![]() ![]() ![]() |
0..1 | Period | Periodo de tiempo al que se refiere el documento IPS nacional u otro referenciado | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.type | Base | extensible | Tipos de Documento Clínico para DocumentReference | 📦0.1.0 | This IG |
| DocumentReference.category | Base | extensible | Categorías de Documento Clínico para DocumentReference | 📦0.1.0 | This IG |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | MinimalDocumentReference | A reference to a document | |||||
![]() ![]() |
0..1 | id | Logical id of this artifact | |||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | id | Version specific identifier | |||||
![]() ![]() ![]() |
0..1 | instant | When the resource version last changed | |||||
![]() ![]() ![]() |
0..1 | uri | Identifies where the resource comes from | |||||
![]() ![]() ![]() |
0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||
![]() ![]() ![]() |
0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() ![]() |
0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | |||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): 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 | Extension Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() |
0..1 | oid | The homeCommunityId where the artifact resides URL: https://profiles.ihe.net/ITI/MHD/StructureDefinition/ihe-HomeCommunityId | |||||
![]() ![]() |
1..1 | UniqueIdIdentifier | Identificador único para el documento IPS nacional referenciado. Es el identificador principal del IPS Example Ejemplo de identificador maestro: {"system":"https://repositorio.cl/documentos/ips","value":"IPS-2026-00001"} | |||||
![]() ![]() |
0..* | Identifier | Identificador alternativo para el documento IPS nacional referenciado. Es un identificador secundario del IPS Slice: Unordered, Open by value:type Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them | |||||
![]() ![]() ![]() |
0..1 | EntryUUIDIdentifier | Business identifier for the DocumentReference | |||||
![]() ![]() ![]() |
0..1 | UniqueIdIdentifier | Unique identifier for the referenced Document | |||||
![]() ![]() |
1..1 | code | Estado de la referencia al documento IPS: current|superseded|entered-in-error Binding: MHD DocumentReference status codes (required) | |||||
![]() ![]() |
1..1 | CodeableConcept | Tipo de documento referenciado Binding: Tipos de Documento Clínico para DocumentReference (extensible) | |||||
![]() ![]() ![]() |
0..1 | string | 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 | string | 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 Example Para IPS: http://loinc.org | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Example Código Loinc para IPS: 34133-9 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Example El display asociado: Summary of episode note | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() |
1..1 | CodeableConcept | Categoría del documento referenciado Binding: Categorías de Documento Clínico para DocumentReference (extensible) | |||||
![]() ![]() ![]() |
0..1 | string | 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 | string | 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 Example Para IPS: http://loinc.org | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Symbol in syntax defined by the system Example Loinc Asociado: 60591-5 | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system Example Display asociado al código Loinc: Patient summary Document | |||||
![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept Required Pattern: Resumen clínico de paciente (extensions allowed) | |||||
![]() ![]() |
1..1 | Reference(CL Paciente) | Paciente al que se refiere el documento IPS nacional referenciado | |||||
![]() ![]() |
1..1 | instant | Fecha de creación del documento IPS nacional referenciado | |||||
![]() ![]() |
1..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Autor del documento o IPS nacional referenciado | |||||
![]() ![]() |
0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
![]() ![]() |
0..1 | Reference(Organization) | Organization which maintains the document | |||||
![]() ![]() |
0..* | BackboneElement | Relationships to other documents | |||||
![]() ![]() ![]() |
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 | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | |||||
![]() ![]() ![]() |
1..1 | Reference(DocumentReference) | Target of the relationship | |||||
![]() ![]() |
0..1 | string | Human-readable description | |||||
![]() ![]() |
0..* | CodeableConcept | Etiqueta de seguridad del documento IPS nacional referenciado Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||
![]() ![]() |
1..1 | BackboneElement | Contenido del documento (IPS u otro) nacional referenciado con url reltiva en caso de ser X-Road, o url absoluta en caso de ser un repositorio FHIR. Se define como un campo obligatorio, y se recomienda usar el valor 'Attachment' para indicar que el contenido del documento referenciado es un archivo adjunto que contiene el documento clínico en formato digital. | |||||
![]() ![]() ![]() |
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 | Attachment | Definición del archivo adjunto que contiene el documento referenciado | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
1..1 | code | Mime type of the content, with charset etc. Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Required Pattern: application/fhir+json (extensions allowed) | |||||
![]() ![]() ![]() ![]() |
0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | |||||
![]() ![]() ![]() ![]() |
1..1 | url | URL del archivo adjunto que contiene el documento referenciado, en formato FHIR IPS, Binary IPS u otro documnento en esos formatos. Example General: http://www.acme.com/logo-small.png Example Ejemplo de IPS referenciado en X-Road: /pba/tndXroad/santamarina/docs/ips-xxx | |||||
![]() ![]() ![]() ![]() |
0..1 | unsignedInt | Number of bytes of content (if url provided) | |||||
![]() ![]() ![]() ![]() |
0..1 | base64Binary | Hash del archivo adjunto que contiene el documento IPS nacional referenciado | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Título del archivo adjunto que contiene el documento referenciado Example General: Official Corporate Logo Example Ejemplo de Título del documento contenido referenciado via X-Road: IPS-001 | |||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Date attachment was first created | |||||
![]() ![]() ![]() |
0..1 | Coding | Format/content rules for the document Binding: IHE ValueSet of Format Codes for use with Document Sharing (preferred) | |||||
![]() ![]() |
1..1 | BackboneElement | Contexto del documento IPS nacional u otro referenciado | |||||
![]() ![]() ![]() |
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..* | Reference(Encounter | EpisodeOfCare) | Context of the document content | |||||
![]() ![]() ![]() |
0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
![]() ![]() ![]() |
0..1 | Period | Periodo de tiempo al que se refiere el documento IPS nacional u otro referenciado | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() |
C | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
![]() ![]() ![]() |
0..1 | Reference(Patient) | Patient demographics from source | |||||
![]() ![]() ![]() ![]() |
0..1 | string | 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") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | |||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | Logical reference, when literal reference is not known | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Text alternative for the resource | |||||
![]() ![]() ![]() |
0..* | Reference(Resource) | Related identifiers or resources | |||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| DocumentReference.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std. |
| DocumentReference.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.status | Base | required | MHD DocumentReference status codes | 📦4.2.5 | Mobile access to Health Documents v4.2 |
| DocumentReference.type | Base | extensible | Tipos de Documento Clínico para DocumentReference | 📦0.1.0 | This IG |
| DocumentReference.category | Base | extensible | Categorías de Documento Clínico para DocumentReference | 📦0.1.0 | This IG |
| DocumentReference.relatesTo.code | Base | required | DocumentRelationshipType | 📍4.0.1 | FHIR Std. |
| DocumentReference.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.contentType | Base | required | MimeType | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.attachment.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| DocumentReference.content.format | Base | preferred | IHE ValueSet of Format Codes for use with Document Sharing | 📦1.6.0 | IHE FormatCode Vocabulary v1.6 |
| DocumentReference.context.event | Base | example | v3 Code System ActCode | 📦3.0.0 | THO v7.4 |
| DocumentReference.context.facilityType | Base | example | Facility Type Code Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.practiceSetting | Base | example | Practice Setting Code Value Set | 📍4.0.1 | FHIR Std. |
| DocumentReference.context.sourcePatientInfo.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | DocumentReference | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | DocumentReference | 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 MinimalDocumentReference
Other representations of profile: CSV, Excel, Schematron
contentDocumentReference.content describe la representación del documento y la forma de acceder a ella. En JSON siempre se representa como un arreglo, aunque este perfil limite su cardinalidad a exactamente una repetición (1..1):
"content": [
{
"attachment": {
"contentType": "application/fhir+json",
"url": "https://documentos.ejemplo.org/Bundle/ips-2026-00001",
"title": "Resumen clínico IPS"
}
}
]
La cardinalidad 1..1 implica que:
content;attachment dentro de content;attachment.url.El elemento opcional content.format, heredado de FHIR/MHD, puede utilizarse para declarar una estructura, plantilla o formato documental más específico que el MIME type. No debe utilizarse para describir el mecanismo de transporte X-Road ni reemplaza a attachment.contentType.
attachmentcontent.attachment es un dato complejo de tipo Attachment. En este perfil actúa como descriptor técnico del documento recuperable.
| Sub-elemento | Cardinalidad efectiva | Regla de uso |
|---|---|---|
contentType |
1..1 MS |
Fijo en application/fhir+json. |
data |
0..0 heredado de MHD Minimal |
No se permite contenido Base64 incorporado en el DocumentReference. |
url |
1..1 MS |
Ubicación desde la cual se recupera el documento. |
size |
0..1 heredado |
Tamaño del contenido en bytes, cuando resulte aplicable. |
hash |
0..1 MS |
Hash SHA-1 del contenido, codificado en Base64, según FHIR R4. |
title |
0..1 MS |
Nombre legible para presentar al usuario. |
creation |
0..1 heredado |
Fecha original de creación del contenido, si se dispone de ella. |
La prohibición de data y la obligación de url provienen del perfil padre MHD Minimal. Por lo tanto, una instancia como la siguiente no es válida para este perfil:
"attachment": {
"contentType": "application/fhir+json",
"data": "eyJyZXNvdXJjZVR5cGUiOiJCdW5kbGUifQ=="
}
attachment.contentTypeEl valor application/fhir+json está fijado en el perfil. Esto indica que el contenido obtenido mediante la URL debe poder entregarse como JSON FHIR.
No se debe confundir:
type: tipo clínico del documento, por ejemplo un resumen clínico;content.format: estructura o plantilla específica del documento;attachment.contentType: formato MIME de los bytes recuperados;Content-Type HTTP: formato que efectivamente declara la respuesta HTTP.Si la URL devuelve directamente un PDF con Content-Type: application/pdf, la instancia no representa correctamente el contenido bajo la restricción actual. Para soportar PDF sería necesario modificar el perfil o definir otro perfil que permita ese MIME type.
Si el destino es un recurso FHIR, la ruta debe coincidir con el tipo real:
Bundle de tipo document: Bundle/{id};Binary: Binary/{id}.No debe utilizarse una ruta Binary/{id} para identificar un recurso que en realidad es un Bundle.
attachment.urlLa URL debe identificar una ubicación desde la cual se obtenga el contenido real del documento. Además, debe ser estable para esa versión: no debe reutilizarse más adelante para devolver bytes correspondientes a otro documento o a otra versión.
FHIR R4 permite URL absolutas y relativas en Attachment.url. Si se usa una referencia relativa, FHIR indica que debe resolverse respecto de la URL base del servicio, de forma equivalente a una referencia a recurso.
Ejemplos:
Valor en attachment.url |
Interpretación |
|---|---|
https://repo.ejemplo.org/fhir/Bundle/ips-001 |
URL absoluta; no requiere una base para resolverse. |
Bundle/ips-001 |
Relativa a la base del servicio FHIR. |
/pba/tndXroad/santamarina/docs/ips-xxx |
Ruta relativa al origen o root-relative; requiere que ese origen publique o enrute esa ruta. |
/r1/INSTANCE/CLASS/MEMBER/SUBSYSTEM/SERVICE/docs/ips-001 |
Forma de ruta compatible con una invocación REST directa a un Security Server X-Road, si se conoce su origen y se agregan los encabezados requeridos. |
Una URL relativa no debe interpretarse respecto de la ubicación del archivo JSON ni de la página HTML de la guía.
attachment.hashEn FHIR R4, Attachment.hash corresponde al SHA-1 de los bytes originales y se expresa en Base64. Es útil para detectar cambios accidentales o verificar que se obtuvo la representación esperada.
Ejemplo de cálculo:
openssl dgst -sha1 -binary documento.json | openssl base64 -A
El hash se calcula sobre los bytes recuperados para el MIME type declarado, no sobre una representación Base64 de esos bytes. Este hash no constituye una firma digital y no reemplaza controles de autenticidad, autorización o no repudio.
En documentos generados bajo demanda, o cuando el contenido es un Bundle FHIR publicado mediante las reglas específicas de MHD, hash y size pueden requerir tratamiento especial o estar ausentes.
X-Road actúa como una capa segura de intercambio entre el sistema consumidor y el sistema proveedor. En una llamada REST, el servicio se codifica en la ruta de la solicitud y el consumidor se identifica mediante el encabezado obligatorio X-Road-Client.
La forma general de una llamada REST X-Road es:
GET https://{security-server}/r1/{instance}/{member-class}/{member-code}/{subsystem}/{service-code}/{path}
X-Road-Client: {instance}/{member-class}/{consumer-member-code}/{consumer-subsystem}
Accept: application/fhir+json
Por ejemplo:
GET /r1/AR/GOV/99999999/REPO-DOC/obtener-documento/docs/IPS-2026-00001 HTTP/1.1
Host: security-server.ejemplo.org
X-Road-Client: AR/GOV/88888888/SISTEMA-CONSUMIDOR
Accept: application/fhir+json
X-Road-Client no se almacena en DocumentReference. Se determina en tiempo de ejecución a partir de la identidad del sistema que recupera el documento.
El perfil incluye el siguiente ejemplo:
/pba/tndXroad/santamarina/docs/ips-xxx
Esta ruta puede utilizarse si la arquitectura define un gateway o proxy capaz de interpretarla. Sin embargo, esa sintaxis no es por sí misma la forma estándar de la URL REST de X-Road. Debe documentarse, como mínimo:
serviceId X-Road;GET;X-Road-Client y los demás encabezados de seguridad;Este punto es fundamental:
Attachment de FHIR R4;Document Responder entregue en DocumentReference.content.attachment.url una URL completa que el consumidor pueda utilizar para ejecutar ITI-68.Por lo tanto, una ruta relativa usada como convención interna puede no cumplir estrictamente la regla transaccional de ITI-67, aunque el recurso sea estructuralmente válido.
Para conservar la interoperabilidad MHD y utilizar X-Road, se recomienda que el DocumentReference entregado al consumidor contenga una URL absoluta de un endpoint recuperable:
"url": "https://gateway-documental.ejemplo.org/pba/tndXroad/santamarina/docs/ips-xxx"
El gateway puede traducir internamente esa solicitud a X-Road, construir la ruta /r1/{serviceId}/{path} y agregar los encabezados que correspondan.
También puede publicarse una URL absoluta directa al Security Server:
"url": "https://security-server.ejemplo.org/r1/AR/GOV/99999999/REPO-DOC/obtener-documento/docs/IPS-2026-00001"
En este segundo caso, el cliente debe poder comunicarse con ese Security Server y enviar X-Road-Client.
Si por una decisión de arquitectura se mantiene una referencia relativa, la guía debe declarar expresamente una regla de resolución, por ejemplo:
baseXRoad = https://security-server.ejemplo.org
attachment.url = /r1/AR/GOV/99999999/REPO-DOC/obtener-documento/docs/IPS-2026-00001
URL efectiva = baseXRoad + attachment.url
Esta regla debe considerarse una convención de la guía o del ecosistema, porque la base X-Road no puede deducirse únicamente desde el DocumentReference.
DocumentReference, por ejemplo mediante ITI-67.ReferenciaDocumental.content[0].attachment.contentType y content[0].attachment.url.X-Road-Client y los controles de autenticación requeridos.GET con Accept: application/fhir+json.Content-Type de la respuesta.hash y size, verifica que correspondan al contenido recuperado.Bundle de tipo document que cumpla el perfil IPS esperado.Conforme a ITI-68, una recuperación exitosa devuelve HTTP 200. Entre las respuestas posibles se encuentran 404 para una ubicación desconocida, 410 para un documento ya no disponible, 406 si no se puede entregar el formato solicitado y 403 cuando la solicitud no está permitida.
El siguiente ejemplo usa una URL absoluta de gateway, que es la alternativa recomendada para mantener una ubicación directamente resoluble:
{
"resourceType": "DocumentReference",
"id": "referencia-ips-2026-00001",
"meta": {
"profile": [
"/StructureDefinition/ReferenciaDocumental"
]
},
"masterIdentifier": {
"system": "https://repositorio.salud.gob.ar/documentos/ips",
"value": "IPS-2026-00001"
},
"status": "current",
"type": {
"coding": [
{
"system": "http://loinc.org",
"code": "34133-9",
"display": "Summary of episode note"
}
]
},
"category": [
{
"coding": [
{
"system": "http://loinc.org",
"code": "60591-5",
"display": "Patient summary Document"
}
],
"text": "Resumen clínico de paciente"
}
],
"subject": {
"reference": "Patient/paciente-123"
},
"date": "2026-08-24T10:00:00-03:00",
"author": [
{
"reference": "Practitioner/profesional-123"
}
],
"content": [
{
"attachment": {
"contentType": "application/fhir+json",
"url": "https://gateway-documental.ejemplo.org/pba/tndXroad/santamarina/docs/ips-2026-00001",
"title": "IPS-2026-00001"
}
}
],
"context": {
"period": {
"start": "2026-08-20T08:00:00-03:00",
"end": "2026-08-20T18:00:00-03:00"
}
}
}
Este ejemplo representa la convención de proxy incluida en el perfil. Solo debe utilizarse si la guía define formalmente su base y mecanismo de resolución:
Instance: ReferenciaDocumentalXRoadEjemplo
InstanceOf: ReferenciaDocumental
Usage: #example
Title: "Referencia documental recuperable mediante X-Road"
* id = "referencia-documental-xroad-ejemplo"
* meta.profile = Canonical(ReferenciaDocumental)
* status = #current
* masterIdentifier.system = "https://repositorio.salud.gob.ar/documentos/ips"
* masterIdentifier.value = "IPS-2026-00001"
* type.coding.system = "http://loinc.org"
* type.coding.code = #34133-9
* type.coding.display = "Summary of episode note"
* category.coding.system = "http://loinc.org"
* category.coding.code = #60591-5
* category.coding.display = "Patient summary Document"
* category.text = "Resumen clínico de paciente"
* subject = Reference(Patient/paciente-123)
* date = "2026-08-24T10:00:00-03:00"
* author = Reference(Practitioner/profesional-123)
* content.attachment.contentType = #application/fhir+json
* content.attachment.url = "/pba/tndXroad/santamarina/docs/ips-xxx"
* content.attachment.title = "IPS-2026-00001"
* context.period.start = "2026-08-20T08:00:00-03:00"
* context.period.end = "2026-08-20T18:00:00-03:00"
attachment.url.GET; poder descubrir un DocumentReference no implica estar autorizado para obtener su contenido.securityLabel cuando el dominio de intercambio requiera comunicar sensibilidad o restricciones de manejo.Provenance.signature, cuando se necesite autenticidad o no repudio; attachment.hash solo comprueba integridad técnica.ReferenciaDocumental en meta.profile.masterIdentifier es único, estable y específico de la versión documental.status, type, category, subject, date y al menos un author están presentes.PacienteCl.content y un attachment.attachment.data.attachment.contentType es application/fhir+json.attachment.url permite recuperar el contenido real mediante GET.serviceId, ruta, X-Road-Client, autorización y MIME type de respuesta.hash, se calculó como SHA-1 sobre los bytes correctos y se codificó en Base64.Bundle tipo document.