Ú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

CapabilityStatement: Configuración del Servidor FHIR de ÚNICAS

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

Configuración del Servidor FHIR de ÚNICAS

  • Implementation Guide Version: 0.0.1
  • FHIR Version: 5.0.0
  • Supported Formats: xml, json
  • Supported Patch Formats:
  • Published on: 2025-03-24 11:36:43+0000
  • Published by: null

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.

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

Summary of System-wide Interactions

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRV-RSUPCSearches_include_revincludeOperations
PatientSupported Profiles
  Patient Paciente ÚNICAS
yyyyyyidentifier, name, given, family, gender, birthdate, death-date, deceased, address, telecom, phone, email, organization
OrganizationSupported Profiles
  Organization Institución ÚNICAS
yyyyyyidentifier, name, address, endpoint
PractitionerSupported Profiles
  Practitioner Profesional Sanitario ÚNICAS
yyyyyyidentifier, name, given, family, gender, address, telecom, phone, email
PractitionerRoleSupported Profiles
  PractitionerRole Profesional Sanitario ÚNICAS
yyyyyyidentifier, organization, practitioner, role
CarePlanSupported Profiles
  CarePlan Gestor del Proceso ÚNICAS
yyyyyy
EncounterSupported Profiles
  Encounter Interacción Clínica ÚNICAS
yyyyyyidentifier, class, patient, participant, participant-type, practitioner, service-provider, reason-code, status, diagnosis-reference, diagnosis-code, appointment
GoalSupported Profiles
  Goal Objetivo ÚNICAS
yyyyyy
TaskSupported Profiles
  Task Tarea ÚNICAS
yyyyyy
DocumentReferenceSupported Profiles
  DocumentReference Documento en Base64 ÚNICAS
yyyyyyidentifier, type, date, patient, custodian, author, contenttype, context, description, status, doc-status
BinarySupported Profiles
  Binary Documento en Base64 ÚNICAS
yyyyyy
AllergyIntoleranceSupported Profiles
  AllergyIntolerance Alergia ÚNICAS
yyyyyyidentifier, clinical-status, code, criticality, date, last-date, manifestation-code, patient, participant, route, severity, verification-status
AppointmentSupported Profiles
  Appointment Cita Agenda ÚNICAS
yyyyyyidentifier, status, service-category, service-type, patient, practitioner, actor, date, reason-code, location
ConditionSupported Profiles
  Condition Diagnóstico ÚNICAS
  Condition Enfermedad ÚNICAS
yyyyyyidentifier, onset-date, category, clinical-status, code, patient, participant-actor, encounter, evidence
DiagnosticReportSupported Profiles
  DiagnosticReport Formulario de Enrolamiento ÚNICAS
yyyyyyidentifier, category, code, date, patient, performer, status, encounter, conclusion
EndpointSupported Profiles
  Endpoint Sistema de Información ÚNICAS
yyyyyyidentifier, connection-type, name, organization, status
FamilyMemberHistorySupported Profiles
  FamilyMemberHistory Antecedente Familiar ÚNICAS
yyyyyyidentifier, code, patient, relationship, sex, status
ImmunizationSupported Profiles
  Immunization Inmunización ÚNICAS
yyyyyyidentifier, vaccine-code, date, patient, performer, lot-number, reason-code, status
LocationSupported Profiles
  Location Localización y Servicio Asistencial ÚNICAS
yyyyyyidentifier, address, name, organization, status, type
MedicationSupported Profiles
  Medication Medicación ÚNICAS
yyyyyyidentifier, code, form, ingredient-code, status
MedicationAdministrationSupported Profiles
  MedicationAdministration Prescripción ÚNICAS
yyyyyyidentifier, code, medication, date, patient, performer, status, encounter
MedicationStatementSupported Profiles
  MedicationStatement Prescripción ÚNICAS
yyyyyyidentifier, code, medication, effective, patient, source, status, encounter
ObservationSupported Profiles
  Observation Dato Antropométrico ÚNICAS
  Observation Hábito No Saludable ÚNICAS
  Observation Hábito Tóxico ÚNICAS
  Observation Obstetrico ÚNICAS
yyyyyyidentifier, 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
ProcedureSupported Profiles
  Procedure Procedimiento Quirúrgico ÚNICAS
yyyyyyidentifier, category, code, patient, performer, date, status, encounter
BundleSupported 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
yyyyyyidentifier, timestamp, type

Resource Conformance: SHALL Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Supported Profiles

Patient Paciente ÚNICAS

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

A patient identifier

SHALLnamestring

A server defined search that may match any of the string fields in the HumanName, including family, given, prefix, suffix, and/or text

SHALLgivenstring

A portion of the given name of the patient

SHALLfamilystring

A portion of the family name of the patient

SHALLgendertoken

Gender of the patient

SHALLbirthdatedate

The patient's date of birth

SHALLdeath-datedate

The date of death has been provided and satisfies this search value

SHALLdeceasedtoken

This patient has been marked as deceased, or has a death date entered

SHALLaddressstring

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

SHALLtelecomtoken

The value in any kind of telecom details of the patient

SHALLphonetoken

A value in a phone contact

SHALLemailtoken

A value in an email contact

SHALLorganizationreference

The organization that is the custodian of the patient record

 

Resource Conformance: SHALL Organization

Core FHIR Resource
Organization
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Any identifier for the organization (not the accreditation issuer's identifier)

SHALLnamestring

A portion of the organization's name or alias

SHALLaddressstring

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

SHALLendpointreference

Technical endpoints providing access to services operated for the organization

 

Resource Conformance: SHALL Practitioner

Core FHIR Resource
Practitioner
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

A practitioner's Identifier

SHALLnamestring

A server defined search that may match any of the string fields in the HumanName, including family, give, prefix, suffix, suffix, and/or text

SHALLgivenstring

A portion of the given name

SHALLfamilystring

A portion of the family name

SHALLgendertoken

Gender of the practitioner

SHALLaddressstring

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

SHALLtelecomtoken

The value in any kind of contact

SHALLphonetoken

A value in a phone contact

SHALLemailtoken

A value in an email contact

 

Resource Conformance: SHALL PractitionerRole

Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

A practitioner's Identifier

SHALLorganizationreference

The identity of the organization the practitioner represents / acts on behalf of

SHALLpractitionerreference

Practitioner that is able to provide the defined services for the organization

SHALLroletoken

The practitioner can perform this role at for the organization

 

Resource Conformance: SHALL CarePlan

Core FHIR Resource
CarePlan
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Resource Conformance: SHALL Encounter

Core FHIR Resource
Encounter
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Identifier(s) by which this encounter is known

SHALLclasstoken

Classification of patient encounter

SHALLpatientreference

The patient present at the encounter

SHALLparticipantreference

Persons involved in the encounter other than the patient

SHALLparticipant-typetoken

Role of participant in encounter

SHALLpractitionerreference

Persons involved in the encounter other than the patient

SHALLservice-providerreference

The organization (facility) responsible for this encounter

SHALLreason-codetoken

Reference to a concept (coded)

SHALLstatustoken

planned | in-progress | on-hold | completed | cancelled | entered-in-error | unknown

SHALLdiagnosis-referencereference

The diagnosis or procedure relevant to the encounter (resource reference)

SHALLdiagnosis-codetoken

The diagnosis or procedure relevant to the encounter (coded)

SHALLappointmentreference

The appointment that scheduled this encounter

 

Resource Conformance: SHALL Goal

Core FHIR Resource
Goal
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Supported Profiles

Goal Objetivo ÚNICAS

Resource Conformance: SHALL Task

Core FHIR Resource
Task
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Supported Profiles

Task Tarea ÚNICAS

Resource Conformance: SHALL DocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Identifier of the attachment binary

SHALLtypetoken

Kind of document (LOINC if possible)

SHALLdatedate

When this document reference was created

SHALLpatientreference

Who/what is the subject of the document

SHALLcustodianreference

Organization which maintains the document

SHALLauthorreference

Who and/or what authored the document

SHALLcontenttypetoken

Mime type of the content, with charset etc.

SHALLcontextreference

Context of the document content

SHALLdescriptionstring

Human-readable description

SHALLstatustoken

current | superseded | entered-in-error

SHALLdoc-statustoken

preliminary | final | amended | entered-in-error

 

Resource Conformance: SHALL Binary

Core FHIR Resource
Binary
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Resource Conformance: SHALL AllergyIntolerance

Core FHIR Resource
AllergyIntolerance
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

External ids for this item

SHALLclinical-statustoken

active | inactive | resolved

SHALLcodetoken

Code that identifies the allergy or intolerance

SHALLcriticalitytoken

low | high | unable-to-assess

SHALLdatedate

Date first version of the resource instance was recorded

SHALLlast-datedate

Date(/time) of last known occurrence of a reaction

SHALLmanifestation-codetoken

Clinical symptoms/signs associated with the Event

SHALLpatientreference

Who the sensitivity is for

SHALLparticipantreference

Who or what participated in the activities related to the allergy or intolerance

SHALLroutetoken

How the subject was exposed to the substance

SHALLseveritytoken

mild | moderate | severe (of event as a whole)

SHALLverification-statustoken

unconfirmed | presumed | confirmed | refuted | entered-in-error

 

Resource Conformance: SHALL Appointment

Core FHIR Resource
Appointment
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

An Identifier of the Appointment

SHALLstatustoken

The overall status of the appointment

SHALLservice-categorytoken

A broad categorization of the service that is to be performed during this appointment

SHALLservice-typetoken

The specific service (by coding) that is to be performed during this appointment

SHALLpatientreference

One of the individuals of the appointment is this patient

SHALLpractitionerreference

One of the individuals of the appointment is this practitioner

SHALLactorreference

Any one of the individuals participating in the appointment

SHALLdatedate

Appointment date/time.

SHALLreason-codetoken

Reference to a concept (by class)

SHALLlocationreference

This location is listed in the participants of the appointment

 

Resource Conformance: SHALL Condition

Core FHIR Resource
Condition
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

A unique identifier of the condition record

SHALLonset-datedate

Date related onsets (dateTime and Period)

SHALLcategorytoken

The category of the condition

SHALLclinical-statustoken

The clinical status of the condition

SHALLcodetoken

Code for the condition

SHALLpatientreference

Who has the condition?

SHALLparticipant-actorreference

Who or what participated in the activities related to the condition

SHALLencounterreference

The Encounter during which this Condition was created

SHALLevidencetoken

Manifestation/symptom

 

Resource Conformance: SHALL DiagnosticReport

Core FHIR Resource
DiagnosticReport
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

An identifier for the report

SHALLcategorytoken

Which diagnostic discipline/department created the report

SHALLcodetoken

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

SHALLdatedate

The clinically relevant time of the report

SHALLpatientreference

The subject of the report if a patient

SHALLperformerreference

Who is responsible for the report

SHALLstatustoken

The status of the report

SHALLencounterreference

The Encounter when the order was made

SHALLconclusiontoken

A coded conclusion (interpretation/impression) on the report

 

Resource Conformance: SHALL Endpoint

Core FHIR Resource
Endpoint
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Identifies this endpoint across multiple systems

SHALLconnection-typetoken

Protocol/Profile/Standard to be used with this endpoint connection

SHALLnamestring

A name that this endpoint can be identified by

SHALLorganizationreference

The organization that is managing the endpoint

SHALLstatustoken

The current status of the Endpoint (usually expected to be active)

 

Resource Conformance: SHALL FamilyMemberHistory

Core FHIR Resource
FamilyMemberHistory
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

A search by a record identifier

SHALLcodetoken

A search by a condition code

SHALLpatientreference

The identity of a subject to list family member history items for

SHALLrelationshiptoken

A search by a relationship type

SHALLsextoken

A search by a sex code of a family member

SHALLstatustoken

partial | completed | entered-in-error | health-unknown

 

Resource Conformance: SHALL Immunization

Core FHIR Resource
Immunization
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Business identifier

SHALLvaccine-codetoken

Vaccine Product Administered

SHALLdatedate

Vaccination (non)-Administration Date

SHALLpatientreference

The patient for the vaccination record

SHALLperformerreference

The practitioner, individual or organization who played a role in the vaccination

SHALLlot-numberstring

Vaccine Lot Number

SHALLreason-codetoken

Reason why the vaccine was administered

SHALLstatustoken

Immunization event status

 

Resource Conformance: SHALL Location

Core FHIR Resource
Location
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

An identifier for the location

SHALLaddressstring

A (part of the) address of the location

SHALLnamestring

A portion of the location's name or alias

SHALLorganizationreference

Searches for locations that are managed by the provided organization

SHALLstatustoken

Searches for locations with a specific kind of status

SHALLtypetoken

A code for the type of location

 

Resource Conformance: SHALL Medication

Core FHIR Resource
Medication
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Returns medications with this external identifier

SHALLcodetoken

Returns medications for a specific code

SHALLformtoken

Returns medications for a specific dose form

SHALLingredient-codetoken

Returns medications for this ingredient code

SHALLstatustoken

Returns medications for this status

 

Resource Conformance: SHALL MedicationAdministration

Core FHIR Resource
MedicationAdministration
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Return administrations with this external identifier

SHALLcodetoken

Return administrations of this medication code

SHALLmedicationreference

Return administrations of this medication reference

SHALLdatedate

Date administration happened (or did not happen)

SHALLpatientreference

The identity of a patient to list administrations for

SHALLperformerreference

The identity of the individual who administered the medication

SHALLstatustoken

MedicationAdministration event status (for example one of active/paused/completed/nullified)

SHALLencounterreference

Return administrations that share this encounter

 

Resource Conformance: SHALL MedicationStatement

Core FHIR Resource
MedicationStatement
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Return statements with this external identifier

SHALLcodetoken

Return statements of this medication code

SHALLmedicationreference

Return statements of this medication reference

SHALLeffectivedate

Date when patient was taking (or not taking) the medication

SHALLpatientreference

Returns statements for a specific patient.

SHALLsourcereference

Who or where the information in the statement came from

SHALLstatustoken

Return statements that match the given status

SHALLencounterreference

Returns statements for a specific encounter

 

Resource Conformance: SHALL Observation

Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

The unique id for a particular observation

SHALLcategorytoken

The classification of the type of observation

SHALLcodetoken

The code of the observation type

SHALLpatientreference

The subject that the observation is about (if patient)

SHALLperformerreference

Who performed the observation

SHALLdatedate

Clinically relevant time/time-period for observation

SHALLstatustoken

The status of the observation

SHALLcode-value-conceptcomposite

Code and coded value parameter pair

SHALLcode-value-quantitycomposite

Code and quantity value parameter pair

SHALLcode-value-strincomposite

Code and string value parameter pair

SHALLcombo-codetoken

The code of the observation type or component type

SHALLcombo-code-value-conceptcomposite

Code and coded value parameter pair, including in components

SHALLcombo-code-value-quantitycomposite

Code and quantity value parameter pair, including in components

SHALLcombo-value-concepttoken

The value or component value of the observation, if the value is a CodeableConcept

SHALLcombo-value-quantityquantity

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)

SHALLcomponent-codetoken

The component code of the observation type

SHALLcomponent-code-value-conceptcomposite

Component code and component coded value parameter pair

SHALLcomponent-code-value-quantitycomposite

Component code and component quantity value parameter pair

SHALLcomponent-value-concepttoken

The value of the component observation, if the value is a CodeableConcept

SHALLcomponent-value-quantitquantity

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)

SHALLvalue-concepttoken

The value of the observation, if the value is a CodeableConcept

SHALLvalue-datedate

The value of the observation, if the value is a date or period of time

SHALLvalue-quantityquantity

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)

 

Resource Conformance: SHALL Procedure

Core FHIR Resource
Procedure
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

A unique identifier for a procedure

SHALLcategorytoken

Classification of the procedure

SHALLcodetoken

A code to identify a procedure

SHALLpatientreference

Search by subject - a patient

SHALLperformerreference

Who performed the procedure

SHALLdatedate

When the procedure occurred or is occurring

SHALLstatustoken

preparation | in-progress | not-done | on-hold | stopped | completed | entered-in-error | unknown

SHALLencounterreference

The Encounter during which this Procedure was created

 

Resource Conformance: SHALL Bundle

Core FHIR Resource
Bundle
Reference Policy
Interaction summary
  • Supports create, search-type, read, vread, update, patch.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Persistent identifier for the bundle

SHALLtimestampdate

When the bundle was assembled

SHALLtypetoken

document | message | transaction | transaction-response | batch | batch-response | history | searchset | collection | subscription-notification

 

ÚNICAS está impulsado por el Consejo Interterritorial del Sistema Nacional de Salud, y financiado con fondos Next Generation de la Unión Europea, en el marco del Plan de Recuperación, Transformación y Resiliencia del Gobierno de España. El Ministerio de Sanidad ejerce la coordinación del proyecto, y Cataluña lidera la parte del desarrollo de los activos tecnológicos para su implementación.