Sentencias de capacidad de FHIR
Revise los recursos, interacciones, operaciones, formatos y parámetros de búsqueda soportados por las API de FHIR de boleta electoral R4 y R6 de DDFS R4 y R6.
Creación de una instancia y obtención de la URL de API de FHIR
Después de crear una instancia de DDFS y que alcance el estado de ciclo de vida ACTIVE, utilice fhirServiceEndpoint para crear y gestionar recursos de FHIR.
Si ya tiene una instancia de DDFS, haga que los detalles de la instancia recuperen su fhirServiceEndpoint.
Utilice el fhirServiceEndpoint devuelto para obtener la URL base para la versión de FHIR requerida por el flujo de trabajo:
URL base de FHIR R4 (4.0.1):
https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4
URL base de la boleta FHIR R6-4 (6.0.0-ballot4):
https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4
¿Qué es una declaración de capacidad?
Una FHIR CapabilityStatement describe la funcionalidad de un servidor FHIR, que incluye:
- Recursos soportados, como
PatientyObservation. - Interacciones soportadas, como
create,read,vread,update,deleteysearch-type. - Operaciones, formatos y parámetros de búsqueda de recursos admitidos.
Para conocer las definiciones estándar, consulte CapabilityStatement (FHIR R4) y CapabilityStatement (FHIR R6).
Archivos de extracto de capacidad publicados
Los siguientes archivos JSON describen las API de FHIR soportadas. La creación y restauración de PUT requieren updateCreate=true en la respuesta de metadatos activos; consulte Creación y restauración de PUT.
- ddfs-r4.json (FHIR 4.0.1)
- ddfs-r6.json (FHIR 6.0.0-ballot4)
Cada archivo contiene un elemento rest en modo servidor con una lista de recursos que declara las interacciones, las operaciones y los parámetros de búsqueda soportados para esa versión de FHIR.
Funciones de los archivos estáticos y del servidor activo
Utilice los archivos JSON publicados para revisar las API de FHIR soportadas. Utilice el punto final de metadatos activo para confirmar las capacidades de la instancia de DDFS.
- Obtenga la sentencia de capacidad FHIR R4 mediante el punto final de metadatos R4.
- Obtenga la sentencia de capacidad FHIR R6 mediante el punto final de metadatos R6.
URL de metadatos de FHIR R4:
https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4/metadata
URL de metadatos de boleta electoral de FHIR R6-4:
https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4/metadata
Compare la respuesta en directo con el archivo JSON publicado para la misma versión de FHIR al validar un despliegue o investigar un problema de integración.
Códigos de estado de punto final de metadatos
Una solicitud de metadatos correcta devuelve 200 OK y la FHIR específica de la versión CapabilityStatement en el cuerpo de la respuesta.
Para ver los códigos de respuesta correctos documentados en los puntos finales de FHIR de DDFS, consulte FHIR Successful Response Status Codes. Las respuestas de error pueden incluir una FHIR OperationOutcome; consulte Reference: OperationOutcome Errors.
Capacidades publicadas
Los archivos R4 y R6 publicados actualmente declaran:
- Formatos
application/fhir+jsonyapplication/json. - Interacciones
create,read,vread,update,deleteysearch-typepara cada recurso indicado. - Operaciones
$hardDeletey$purgeDeletedpara cada recurso mostrado. - Operación
$statuspara el recursoSubscriptionde R6. - 23 tipos de recursos R4 y once tipos de recursos R6.
Para cada recurso mostrado, los archivos actuales anuncian _count, _total, _id, _lastUpdated, _profile y _tag. Los archivos no anuncian _page. Utilice solo los controles que se muestran para el recurso y la versión de destino.
El contrato de búsqueda actual específico del recurso incluye los siguientes detalles notables:
- R4 y R6
Encounteranuncian el parámetro de tokendischarge-dispositionde DDFS. - R4
Locationanunciaidentifier,statusypartof. R6Locationtambién anunciaform. - R4
Provenanceutiliza la definición de tokenactivityde DDFS publicada. PractitionerRoleanuncia el parámetro de referenciapractitioner. Su definición de SearchParameter publicada soporta el modificador:identifiery las cadenas.identifiery.name; no se anuncian entradas de metadatos separadas con puntos.- R4
Groupno anunciacharacteristic,characteristic-value,excludenivalue.
La operación $purgeDeleted acepta entradas before y opcionales limit en un cuerpo POST Parameters de FHIR. No anuncia esas entradas como parámetros de consulta.
Consulte el archivo JSON o la respuesta de metadatos activos para obtener las listas completas de recursos y parámetros de búsqueda. No suponga que una capacidad R4 también está disponible en R6, o que una capacidad R6 está disponible en R4.
Uso de una Sentencia de Capacidad
Utilizar una sentencia de capacidad para:
- Confirme que se admite un recurso, interacción, operación, formato o parámetro de búsqueda antes de llamarlo.
- Configure las herramientas de cliente o revise un artefacto de versión fuera de línea.
- Compare las capacidades documentadas con un despliegue activo.
Utilice uno de los siguientes ejemplos para recuperar una sentencia de capacidad activa y mostrar sus recursos, interacciones y operaciones declarados.
URL de metadatos de FHIR R4:
https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r4/metadata
URL de metadatos de boleta electoral de FHIR R6-4:
https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4/metadata
En los ejemplos se utiliza la URL de metadatos de boleta electoral-4 R6. Utilice la URL de metadatos R4 al trabajar con la API R4.
El siguiente ejemplo utiliza curl y jq:
curl -sS \ -H "Accept: application/fhir+json" \ "https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4/metadata" | jq '.rest[0].resource[] | {type: .type, interactions: [.interaction[]?.code], operations: [.operation[]?.name]}'$capabilityStatement = Invoke-RestMethod ` -Method Get ` -Uri "https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4/metadata" ` -Headers @{ Accept = "application/fhir+json" } foreach ($resource in $capabilityStatement.rest[0].resource) { [PSCustomObject]@{ Type = $resource.type Interactions = @($resource.interaction.code) -join ", " Operations = @($resource.operation.name) -join ", " } }Guarde el siguiente ejemplo como un archivo
.mjsy ejecútelo con Node.js 18 o posterior:const response = await fetch("https://<ddfs-instance-id>.ddfs.<region>.oci.oraclecloud.com/api/fhir/r6-ballot4/metadata", { headers: { Accept: "application/fhir+json" } }); if (!response.ok) { throw new Error(`Metadata request failed: ${response.status}`); } const capabilityStatement = await response.json(); for (const resource of capabilityStatement.rest?.[0]?.resource ?? []) { const interactions = (resource.interaction ?? []).map(item => item.code); const operations = (resource.operation ?? []).map(item => item.name); console.log(resource.type, interactions, operations); }
Diferencias R4 y R6
Los conjuntos de recursos admitidos difieren según la versión de FHIR. La sentencia de capacidad R6 publicada incluye DeviceAssociation, Subscription y SubscriptionTopic, y soporta la operación $status para Subscription cuando corresponda. Las operaciones de estado devuelven SubscriptionStatus, pero no se muestran como un recurso CRUD ordinario. La sentencia de capacidad R4 publicada incluye recursos que no se muestran en el archivo R6.
- Consulte FHIR R4 resources.
- Consulte Recursos de FHIR R6.
- Consulte Interoperabilidad de R4 y R6.
Comportamiento de cliente compatible con versiones posteriores
Utilice análisis compatibles con el futuro y evite suposiciones de codificación fija sobre campos opcionales. Compruebe la sentencia de capacidad para el servidor de destino y la versión de FHIR antes de activar el comportamiento opcional del cliente.
Para obtener orientación relacionada, consulte Compatibilidad de versiones y contenido normativo de FHIR y Operaciones de depuración y supresión de datos.
Detalles de contrato de FHIR
En esta sección, se resumen los artefactos de la versión estática. Utilice la orientación que la rodea y la respuesta /metadata activa coincidente para validar un servicio desplegado.
Liberar resumen de artefacto
| Superficie de FHIR | Definición | Versión de FHIR | Estado | Tipo de capacidad | Recursos | Formatos |
|---|---|---|---|---|---|---|
| 4ª | ddfs-r4.json | 4 | activa | instancia | 22 | aplicación/fhir+json, aplicación/json |
| R6 boleta4 | ddfs-r6.json | 6.0.0-ballot4 | activa | instancia | 11 | aplicación/fhir+json, aplicación/json |
Comportamiento anunciado
La búsqueda utiliza la declaración de recuento de cada recurso y parámetro. Un guion significa que CapabilityStatement no anuncia ningún valor para ese campo.
| Superficie de FHIR | Interacciones | Operaciones | Usos de búsqueda | Incluye | La reversión incluye |
|---|---|---|---|---|---|
| 4ª | crear, suprimir, leer, tipo de búsqueda, actualizar, vread | $hardDelete, $purgeDeleted | 250 | PracticanteRol: punto final, PracticanteRol: practicante | Procedencia:target |
| R6 boleta4 | crear, suprimir, leer, tipo de búsqueda, actualizar, vread | $hardDelete, $purgeDeleted, $status | 120 | — | Procedencia:target |
Detalles de publicación de artefacto
| Superficie de FHIR | ID DE FHIR | Nombre de Definición | Title | Experimental | Publicado | Editor |
|---|---|---|---|---|---|---|
| 4ª | ddfs-r4 |
DDFSFhirR4CapabilityStatement | Declaración de capacidad del servidor DDFS FHIR R4 | Nº | 2026-06-01T00:00:00Z | Oracle |
| R6 boleta4 | ddfs-r6 |
DDFSFhirR6CapabilityStatement | Declaración de capacidad del servidor de la boleta 4 de DDFS FHIR R6 | Nº | 2026-08-06T00:00:00Z | Oracle |
Declaraciones de despliegue
| Superficie de FHIR | Software | Descripción de capacidad | Descripción del servicio | Rol de REST |
|---|---|---|---|---|
| 4ª | Servidor FHIR de DDFS | DDFS FHIR R4 API | servidor | |
| R6 boleta4 | Servidor FHIR de DDFS | Capacidades del servidor DDFS que implementa HL7 FHIR 6.0.0-ballot4 en la ruta base /api/fhir/r6-ballot4. | DDFS FHIR R6 Ballot 4 (6.0.0-ballot4) API en /api/fhir/r6-ballot4 | servidor |
Los artefactos estáticos no declaran implementation.url. Obtenga la URL de la base de servicio de la instancia de DDFS y confirme el contrato desplegado a través de su punto final de metadatos.
Declaraciones de autenticación y de autorización
Estas declaraciones se publican en cada CapabilityStatement. Consulte la referencia de autenticación para obtener ejemplos de configuración.
| Superficie de FHIR | Declaración de seguridad |
|---|---|
| 4ª | Los puntos finales de FHIR requieren autenticación JWT de portador a menos que sean explícitamente anónimos. DDFS evalúa los ámbitos de recursos de FHIR canónicos en el token de acceso, como system/Patient.rs, y admite permisos con comodines como system/*.rs. En los dominios de identidad de OCI, defina los ámbitos de servidor de recursos en el formato canónico de sistema/...; los clientes solicitan el formato de prefijo de DDFS correspondiente, como ddfssystem/Patient.rs. Los dominios de identidad emiten el ámbito canónico no fijo en el token de acceso. Las operaciones de supresión estricta necesitan tanto la autoridad de supresión del sistema/{Resource}.d coincidente como el ámbito personalizado exacto https://docs.oracle.com/iaas/device-data-fhir/scopes/hard-delete. Este servidor no da a conocer la autorización, el token, el contexto de inicio ni los puntos finales de detección conocidos en esta sentencia de capacidad. |
| R6 boleta4 | Los puntos finales de FHIR requieren autenticación JWT de portador a menos que sean explícitamente anónimos. DDFS evalúa los ámbitos de recursos de FHIR canónicos en el token de acceso, como system/Patient.rs, y admite permisos con comodines como system/*.rs. En los dominios de identidad de OCI, defina los ámbitos de servidor de recursos en el formato canónico de sistema/...; los clientes solicitan el formato de prefijo de DDFS correspondiente, como ddfssystem/Patient.rs. Los dominios de identidad emiten el ámbito canónico no fijo en el token de acceso. Las operaciones de supresión estricta necesitan tanto la autoridad de supresión del sistema/{Resource}.d coincidente como el ámbito personalizado exacto https://docs.oracle.com/iaas/device-data-fhir/scopes/hard-delete. Este servidor no da a conocer la autorización, el token, el contexto de inicio ni los puntos finales de detección conocidos en esta sentencia de capacidad. |
Versión de votación R6
El contrato R6 está bloqueado por la versión en 6.0.0-ballot4. Utilice cargas útiles para esta versión exacta de FHIR y compruebe el punto final CapabilityStatement antes de enviar solicitudes.