Extensión secreta de OCI Vault de suscripción de FHIR R6

Utilice la extensión DDFS FHIR R6 para hacer referencia a un secreto de OCI Vault cuyo valor se envía como cabecera de autorización de salida para solicitudes de establecimiento de comunicación y notificación de eventos de REST-hook.

Este tema define la extensión. Para ver la secuencia de notificación completa, consulte FHIR R6 Subscription Workflow.

Definición de extensión

PropiedadValor
URL canónicahttps://docs.oracle.com/iaas/device-data-fhir/StructureDefinition/subscription-oci-vault-secret.json
Versión de FHIR6.0.0-ballot4
ContextoRecurso Subscription raíz
Cardinalidad0..1
ValorSe necesita valueString que contenga un OCID secreto de OCI Vault cuando la extensión esté presente

La extensión es opcional. DDFS resuelve el secreto al que se hace referencia para cada solicitud de reconocimiento y notificación de eventos de protocolo de enlace de REST y envía el valor resuelto literalmente como cabecera Authorization saliente. Las llamadas entrantes que crean o actualizan la suscripción aún requieren los ámbitos y el token de acceso normales de la API de FHIR de DDFS.

Valor secreto y política de acceso

Almacene el valor completo esperado por el punto final de recepción en el secreto de OCI Vault. Por ejemplo, para la autorización del portador, almacene Bearer <token>. Al crear un secreto, seleccione Generación manual de secretos para proporcionar el valor del secreto.

Antes de crear una suscripción que utilice la extensión, otorgue permiso a la instancia de DDFS para leer el secreto específico. Consulte Otorgar acceso a DDFS a un secreto de autorización de suscripción.

Comportamiento operativo

DDFS resuelve y aplica el secreto cuando prepara cada solicitud de bloqueo de REST, después de la respuesta de creación o actualización síncrona. Una respuesta de creación de suscripción correcta no confirma que DDFS pueda leer el secreto o completar el establecimiento de comunicación.

Si DDFS no puede leer ni aplicar el secreto para la solicitud de establecimiento de comunicación, el establecimiento de comunicación falla y el estado de suscripción pasa a ser error. Si el secreto no se puede leer ni aplicar para una notificación de evento posterior, esa notificación de evento es un fallo de entrega.

Subscription.parameter puede incluir cabeceras HTTP personalizadas soportadas. Las cabeceras restringidas incluyen Authorization, Proxy-Authorization, Content-Type, Content-Length, Cookie, Host, Forwarded y cabeceras que comienzan por X-Forwarded-. Utilice esta extensión cuando DDFS deba enviar una cabecera Authorization saliente.

Ejemplo de extensión

Agregue la extensión en la raíz de un recurso de suscripción FHIR R6:

(application/fhir+json)
{
  "extension": [
    {
      "url": "https://docs.oracle.com/iaas/device-data-fhir/StructureDefinition/subscription-oci-vault-secret.json",
      "valueString": "ocid1.vaultsecret.oc1.<region>.<unique-id>"
    }
  ]
}
      

Para conocer el punto final de suscripción y la estructura de solicitud base, consulte Crear suscripción. Para obtener una solicitud completa que utilice esta extensión, consulte Crear una suscripción.

Definición de JSON publicada

Consulte JSON secreto de OCI Vault de suscripción.