ÚNICAS Rare Diseases HL7 FHIR Implementation Guide
0.0.1 - draft
ÚNICAS Rare Diseases HL7 FHIR Implementation Guide - Local Development build (v0.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://unicas-fhir.sanidad.gob.es/CapabilityStatement/UNICASConfiguracionServidor | Version: 0.0.1 | |||
Draft as of 2025-03-24 | Computable Name: UNICASConfiguracionServidor |
Definición de capability statement del servidor FHIR para red ÚNICAS. Este capability statement se describe en detalle toda la funcionalidad y las capacidades del servidor FHIR implementado para la Red ÚNICAS, que incluye ImplementationGuide, StructureDefinition, ValuSet y CodeSystem.
Raw OpenAPI-Swagger Definition file | Download
xml
, json
Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
server
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | V-R | S | U | P | C | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|---|
Patient | Supported Profiles Patient Paciente ÚNICAS | y | y | y | y | y | y | identifier, name, given, family, gender, birthdate, death-date, deceased, address, telecom, phone, email, organization | |||
Organization | Supported Profiles Organization Institución ÚNICAS | y | y | y | y | y | y | identifier, name, address, endpoint | |||
Practitioner | Supported Profiles Practitioner Profesional Sanitario ÚNICAS | y | y | y | y | y | y | identifier, name, given, family, gender, address, telecom, phone, email | |||
PractitionerRole | Supported Profiles PractitionerRole Profesional Sanitario ÚNICAS | y | y | y | y | y | y | identifier, organization, practitioner, role | |||
CarePlan | Supported Profiles CarePlan Gestor del Proceso ÚNICAS | y | y | y | y | y | y | ||||
Encounter | Supported Profiles Encounter Interacción Clínica ÚNICAS | y | y | y | y | y | y | identifier, class, patient, participant, participant-type, practitioner, service-provider, reason-code, status, diagnosis-reference, diagnosis-code, appointment | |||
Goal | Supported Profiles Goal Objetivo ÚNICAS | y | y | y | y | y | y | ||||
Task | Supported Profiles Task Tarea ÚNICAS | y | y | y | y | y | y | ||||
DocumentReference | Supported Profiles DocumentReference Documento en Base64 ÚNICAS | y | y | y | y | y | y | identifier, type, date, patient, custodian, author, contenttype, context, description, status, doc-status | |||
Binary | Supported Profiles Binary Documento en Base64 ÚNICAS | y | y | y | y | y | y | ||||
AllergyIntolerance | Supported Profiles AllergyIntolerance Alergia ÚNICAS | y | y | y | y | y | y | identifier, clinical-status, code, criticality, date, last-date, manifestation-code, patient, participant, route, severity, verification-status | |||
Appointment | Supported Profiles Appointment Cita Agenda ÚNICAS | y | y | y | y | y | y | identifier, status, service-category, service-type, patient, practitioner, actor, date, reason-code, location | |||
Condition | Supported Profiles Condition Diagnóstico ÚNICAS Condition Enfermedad ÚNICAS | y | y | y | y | y | y | identifier, onset-date, category, clinical-status, code, patient, participant-actor, encounter, evidence | |||
DiagnosticReport | Supported Profiles DiagnosticReport Formulario de Enrolamiento ÚNICAS | y | y | y | y | y | y | identifier, category, code, date, patient, performer, status, encounter, conclusion | |||
Endpoint | Supported Profiles Endpoint Sistema de Información ÚNICAS | y | y | y | y | y | y | identifier, connection-type, name, organization, status | |||
FamilyMemberHistory | Supported Profiles FamilyMemberHistory Antecedente Familiar ÚNICAS | y | y | y | y | y | y | identifier, code, patient, relationship, sex, status | |||
Immunization | Supported Profiles Immunization Inmunización ÚNICAS | y | y | y | y | y | y | identifier, vaccine-code, date, patient, performer, lot-number, reason-code, status | |||
Location | Supported Profiles Location Localización y Servicio Asistencial ÚNICAS | y | y | y | y | y | y | identifier, address, name, organization, status, type | |||
Medication | Supported Profiles Medication Medicación ÚNICAS | y | y | y | y | y | y | identifier, code, form, ingredient-code, status | |||
MedicationAdministration | Supported Profiles MedicationAdministration Prescripción ÚNICAS | y | y | y | y | y | y | identifier, code, medication, date, patient, performer, status, encounter | |||
MedicationStatement | Supported Profiles MedicationStatement Prescripción ÚNICAS | y | y | y | y | y | y | identifier, code, medication, effective, patient, source, status, encounter | |||
Observation | Supported Profiles Observation Dato Antropométrico ÚNICAS Observation Hábito No Saludable ÚNICAS Observation Hábito Tóxico ÚNICAS Observation Obstetrico ÚNICAS | y | y | y | y | y | y | identifier, category, code, patient, performer, date, status, code-value-concept, code-value-quantity, code-value-strin, combo-code, combo-code-value-concept, combo-code-value-quantity, combo-value-concept, combo-value-quantity, component-code, component-code-value-concept, component-code-value-quantity, component-value-concept, component-value-quantit, value-concept, value-date, value-quantity | |||
Procedure | Supported Profiles Procedure Procedimiento Quirúrgico ÚNICAS | y | y | y | y | y | y | identifier, category, code, patient, performer, date, status, encounter | |||
Bundle | Supported Profiles Bundle Alergias ÚNICAS Bundle Antecedentes ÚNICAS Bundle Citas Agenda ÚNICAS Bundle Diagnósticos ÚNICAS Bundle Documentos ÚNICAS Bundle Inmunizaciones ÚNICAS Bundle Prescripciones Hospitalarias ÚNICAS | y | y | y | y | y | y | identifier, timestamp, type |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | A patient identifier |
SHALL | name | string | A server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text |
SHALL | given | string | A portion of the given name of the patient |
SHALL | family | string | A portion of the family name of the patient |
SHALL | gender | token | Gender of the patient |
SHALL | birthdate | date | The patient's date of birth |
SHALL | death-date | date | The date of death has been provided and satisfies this search value |
SHALL | deceased | token | This patient has been marked as deceased, or has a death date entered |
SHALL | address | string | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
SHALL | telecom | token | The value in any kind of telecom details of the patient |
SHALL | phone | token | A value in a phone contact |
SHALL | token | A value in an email contact | |
SHALL | organization | reference | The organization that is the custodian of the patient record |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | Any identifier for the organization (not the accreditation issuer's identifier) |
SHALL | name | string | A portion of the organization's name or alias |
SHALL | address | string | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
SHALL | endpoint | reference | Technical endpoints providing access to services operated for the organization |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | A practitioner's Identifier |
SHALL | name | string | A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text |
SHALL | given | string | A portion of the given name |
SHALL | family | string | A portion of the family name |
SHALL | gender | token | Gender of the practitioner |
SHALL | address | string | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
SHALL | telecom | token | The value in any kind of contact |
SHALL | phone | token | A value in a phone contact |
SHALL | token | A value in an email contact |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | A practitioner's Identifier |
SHALL | organization | reference | The identity of the organization the practitioner represents / acts on behalf of |
SHALL | practitioner | reference | Practitioner that is able to provide the defined services for the organization |
SHALL | role | token | The practitioner can perform this role at for the organization |
create
, search-type
, read
, vread
, update
, patch
.create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | Identifier(s) by which this encounter is known |
SHALL | class | token | Classification of patient encounter |
SHALL | patient | reference | The patient present at the encounter |
SHALL | participant | reference | Persons involved in the encounter other than the patient |
SHALL | participant-type | token | Role of participant in encounter |
SHALL | practitioner | reference | Persons involved in the encounter other than the patient |
SHALL | service-provider | reference | The organization (facility) responsible for this encounter |
SHALL | reason-code | token | Reference to a concept (coded) |
SHALL | status | token | planned | in-progress | on-hold | completed | cancelled | entered-in-error | unknown |
SHALL | diagnosis-reference | reference | The diagnosis or procedure relevant to the encounter (resource reference) |
SHALL | diagnosis-code | token | The diagnosis or procedure relevant to the encounter (coded) |
SHALL | appointment | reference | The appointment that scheduled this encounter |
create
, search-type
, read
, vread
, update
, patch
.create
, search-type
, read
, vread
, update
, patch
.create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | Identifier of the attachment binary |
SHALL | type | token | Kind of document (LOINC if possible) |
SHALL | date | date | When this document reference was created |
SHALL | patient | reference | Who/what is the subject of the document |
SHALL | custodian | reference | Organization which maintains the document |
SHALL | author | reference | Who and/or what authored the document |
SHALL | contenttype | token | Mime type of the content, with charset etc. |
SHALL | context | reference | Context of the document content |
SHALL | description | string | Human-readable description |
SHALL | status | token | current | superseded | entered-in-error |
SHALL | doc-status | token | preliminary | final | amended | entered-in-error |
create
, search-type
, read
, vread
, update
, patch
.create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | External ids for this item |
SHALL | clinical-status | token | active | inactive | resolved |
SHALL | code | token | Code that identifies the allergy or intolerance |
SHALL | criticality | token | low | high | unable-to-assess |
SHALL | date | date | Date first version of the resource instance was recorded |
SHALL | last-date | date | Date(/time) of last known occurrence of a reaction |
SHALL | manifestation-code | token | Clinical symptoms/signs associated with the Event |
SHALL | patient | reference | Who the sensitivity is for |
SHALL | participant | reference | Who or what participated in the activities related to the allergy or intolerance |
SHALL | route | token | How the subject was exposed to the substance |
SHALL | severity | token | mild | moderate | severe (of event as a whole) |
SHALL | verification-status | token | unconfirmed | presumed | confirmed | refuted | entered-in-error |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | An Identifier of the Appointment |
SHALL | status | token | The overall status of the appointment |
SHALL | service-category | token | A broad categorization of the service that is to be performed during this appointment |
SHALL | service-type | token | The specific service (by coding) that is to be performed during this appointment |
SHALL | patient | reference | One of the individuals of the appointment is this patient |
SHALL | practitioner | reference | One of the individuals of the appointment is this practitioner |
SHALL | actor | reference | Any one of the individuals participating in the appointment |
SHALL | date | date | Appointment date/time. |
SHALL | reason-code | token | Reference to a concept (by class) |
SHALL | location | reference | This location is listed in the participants of the appointment |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | A unique identifier of the condition record |
SHALL | onset-date | date | Date related onsets (dateTime and Period) |
SHALL | category | token | The category of the condition |
SHALL | clinical-status | token | The clinical status of the condition |
SHALL | code | token | Code for the condition |
SHALL | patient | reference | Who has the condition? |
SHALL | participant-actor | reference | Who or what participated in the activities related to the condition |
SHALL | encounter | reference | The Encounter during which this Condition was created |
SHALL | evidence | token | Manifestation/symptom |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | An identifier for the report |
SHALL | category | token | Which diagnostic discipline/department created the report |
SHALL | code | token | The code for the report, as opposed to codes for the atomic results, which are the names on the observation resource referred to from the result |
SHALL | date | date | The clinically relevant time of the report |
SHALL | patient | reference | The subject of the report if a patient |
SHALL | performer | reference | Who is responsible for the report |
SHALL | status | token | The status of the report |
SHALL | encounter | reference | The Encounter when the order was made |
SHALL | conclusion | token | A coded conclusion (interpretation/impression) on the report |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | Identifies this endpoint across multiple systems |
SHALL | connection-type | token | Protocol/Profile/Standard to be used with this endpoint connection |
SHALL | name | string | A name that this endpoint can be identified by |
SHALL | organization | reference | The organization that is managing the endpoint |
SHALL | status | token | The current status of the Endpoint (usually expected to be active) |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | A search by a record identifier |
SHALL | code | token | A search by a condition code |
SHALL | patient | reference | The identity of a subject to list family member history items for |
SHALL | relationship | token | A search by a relationship type |
SHALL | sex | token | A search by a sex code of a family member |
SHALL | status | token | partial | completed | entered-in-error | health-unknown |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | Business identifier |
SHALL | vaccine-code | token | Vaccine Product Administered |
SHALL | date | date | Vaccination (non)-Administration Date |
SHALL | patient | reference | The patient for the vaccination record |
SHALL | performer | reference | The practitioner, individual or organization who played a role in the vaccination |
SHALL | lot-number | string | Vaccine Lot Number |
SHALL | reason-code | token | Reason why the vaccine was administered |
SHALL | status | token | Immunization event status |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | An identifier for the location |
SHALL | address | string | A (part of the) address of the location |
SHALL | name | string | A portion of the location's name or alias |
SHALL | organization | reference | Searches for locations that are managed by the provided organization |
SHALL | status | token | Searches for locations with a specific kind of status |
SHALL | type | token | A code for the type of location |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | Returns medications with this external identifier |
SHALL | code | token | Returns medications for a specific code |
SHALL | form | token | Returns medications for a specific dose form |
SHALL | ingredient-code | token | Returns medications for this ingredient code |
SHALL | status | token | Returns medications for this status |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | Return administrations with this external identifier |
SHALL | code | token | Return administrations of this medication code |
SHALL | medication | reference | Return administrations of this medication reference |
SHALL | date | date | Date administration happened (or did not happen) |
SHALL | patient | reference | The identity of a patient to list administrations for |
SHALL | performer | reference | The identity of the individual who administered the medication |
SHALL | status | token | MedicationAdministration event status (for example one of active/paused/completed/nullified) |
SHALL | encounter | reference | Return administrations that share this encounter |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | Return statements with this external identifier |
SHALL | code | token | Return statements of this medication code |
SHALL | medication | reference | Return statements of this medication reference |
SHALL | effective | date | Date when patient was taking (or not taking) the medication |
SHALL | patient | reference | Returns statements for a specific patient. |
SHALL | source | reference | Who or where the information in the statement came from |
SHALL | status | token | Return statements that match the given status |
SHALL | encounter | reference | Returns statements for a specific encounter |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | The unique id for a particular observation |
SHALL | category | token | The classification of the type of observation |
SHALL | code | token | The code of the observation type |
SHALL | patient | reference | The subject that the observation is about (if patient) |
SHALL | performer | reference | Who performed the observation |
SHALL | date | date | Clinically relevant time/time-period for observation |
SHALL | status | token | The status of the observation |
SHALL | code-value-concept | composite | Code and coded value parameter pair |
SHALL | code-value-quantity | composite | Code and quantity value parameter pair |
SHALL | code-value-strin | composite | Code and string value parameter pair |
SHALL | combo-code | token | The code of the observation type or component type |
SHALL | combo-code-value-concept | composite | Code and coded value parameter pair, including in components |
SHALL | combo-code-value-quantity | composite | Code and quantity value parameter pair, including in components |
SHALL | combo-value-concept | token | The value or component value of the observation, if the value is a CodeableConcept |
SHALL | combo-value-quantity | quantity | The value or component value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
SHALL | component-code | token | The component code of the observation type |
SHALL | component-code-value-concept | composite | Component code and component coded value parameter pair |
SHALL | component-code-value-quantity | composite | Component code and component quantity value parameter pair |
SHALL | component-value-concept | token | The value of the component observation, if the value is a CodeableConcept |
SHALL | component-value-quantit | quantity | The value of the component observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
SHALL | value-concept | token | The value of the observation, if the value is a CodeableConcept |
SHALL | value-date | date | The value of the observation, if the value is a date or period of time |
SHALL | value-quantity | quantity | The value of the observation, if the value is a Quantity, or a SampledData (just search on the bounds of the values in sampled data) |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | A unique identifier for a procedure |
SHALL | category | token | Classification of the procedure |
SHALL | code | token | A code to identify a procedure |
SHALL | patient | reference | Search by subject - a patient |
SHALL | performer | reference | Who performed the procedure |
SHALL | date | date | When the procedure occurred or is occurring |
SHALL | status | token | preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown |
SHALL | encounter | reference | The Encounter during which this Procedure was created |
create
, search-type
, read
, vread
, update
, patch
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | Persistent identifier for the bundle |
SHALL | timestamp | date | When the bundle was assembled |
SHALL | type | token | document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification |