Iot Connector Fhir Destination - Create Or Update

Servicio:

Healthcare Apis

Versión de la API:

2022-06-01

Crea o actualiza un recurso de destino de FHIR del conector de IoT con los parámetros especificados.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HealthcareApis/workspaces/{workspaceName}/iotconnectors/{iotConnectorName}/fhirdestinations/{fhirDestinationName}?api-version=2022-06-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
fhirDestinationName	path	True	string minLength: 3 maxLength: 24	Nombre del recurso de destino de FHIR del conector de IoT.
iotConnectorName	path	True	string minLength: 3 maxLength: 24	Nombre del recurso del conector de IoT.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+$	Nombre del grupo de recursos que contiene la instancia de servicio.
subscriptionId	path	True	string	Identificador de la suscripción.
workspaceName	path	True	string minLength: 3 maxLength: 24	Nombre del recurso del área de trabajo.
api-version	query	True	string	Versión de api de cliente.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
properties.fhirMapping	True	IotMappingProperties	Asignaciones de FHIR
properties.fhirServiceResourceId	True	string	Identificador de recurso completo del servicio FHIR al que conectarse.
properties.resourceIdentityResolutionType	True	IotIdentityResolutionType	Determina cómo se resuelve la identidad de recursos en el destino.
etag		string	ETAG asociado al recurso, que se usa para la simultaneidad optimista al editarlo.
location		string	Ubicación del recurso.

Respuestas

Nombre	Tipo	Description
200 OK	IotFhirDestination	Actualizado: se ha aceptado la solicitud put y se actualiza un recurso existente.
201 Created	IotFhirDestination	Creado: se acepta la solicitud put y se crea un recurso existente de forma asincrónica.
202 Accepted	IotFhirDestination	Aceptado: la solicitud put aceptada y un recurso existente se actualiza de forma asincrónica.
Other Status Codes	ErrorDetails	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Create or update an Iot Connector FHIR destination

Solicitud de ejemplo

HTTP

PUT https://management.azure.com/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest1?api-version=2022-06-01

{
  "location": "westus",
  "properties": {
    "resourceIdentityResolutionType": "Create",
    "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice",
    "fhirMapping": {
      "content": {
        "templateType": "CollectionFhirTemplate",
        "template": [
          {
            "templateType": "CodeValueFhir",
            "template": {
              "codes": [
                {
                  "code": "8867-4",
                  "system": "http://loinc.org",
                  "display": "Heart rate"
                }
              ],
              "periodInterval": 60,
              "typeName": "heartrate",
              "value": {
                "defaultPeriod": 5000,
                "unit": "count/min",
                "valueName": "hr",
                "valueType": "SampledData"
              }
            }
          }
        ]
      }
    }
  }
}

Respuesta de muestra

status code:

200

{
  "name": "dest1",
  "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest1",
  "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations",
  "location": "West US 2",
  "etag": "00000000-0000-0000-f5ac-912ca49e01d6",
  "properties": {
    "provisioningState": "Succeeded",
    "resourceIdentityResolutionType": "Create",
    "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice",
    "fhirMapping": {
      "content": {
        "templateType": "CollectionFhirTemplate",
        "template": [
          {
            "templateType": "CodeValueFhir",
            "template": {
              "codes": [
                {
                  "code": "8867-4",
                  "system": "http://loinc.org",
                  "display": "Heart rate"
                }
              ],
              "periodInterval": 60,
              "typeName": "heartrate",
              "value": {
                "defaultPeriod": 5000,
                "unit": "count/min",
                "valueName": "hr",
                "valueType": "SampledData"
              }
            }
          }
        ]
      }
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdAt": "2021-01-28T19:26:24.072Z",
    "lastModifiedBy": "string",
    "lastModifiedAt": "2021-01-28T19:26:24.072Z"
  }
}

status code:

201

{
  "name": "dest1",
  "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest1",
  "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations",
  "location": "West US 2",
  "etag": "00000000-0000-0000-f5ac-912ca49e01d6",
  "properties": {
    "provisioningState": "Creating",
    "resourceIdentityResolutionType": "Create",
    "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice",
    "fhirMapping": {
      "content": {
        "templateType": "CollectionFhirTemplate",
        "template": [
          {
            "templateType": "CodeValueFhir",
            "template": {
              "codes": [
                {
                  "code": "8867-4",
                  "system": "http://loinc.org",
                  "display": "Heart rate"
                }
              ],
              "periodInterval": 60,
              "typeName": "heartrate",
              "value": {
                "defaultPeriod": 5000,
                "unit": "count/min",
                "valueName": "hr",
                "valueType": "SampledData"
              }
            }
          }
        ]
      }
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdAt": "2021-01-28T19:26:24.072Z",
    "lastModifiedBy": "string",
    "lastModifiedAt": "2021-01-28T19:26:24.072Z"
  }
}

status code:

202

{
  "name": "dest1",
  "id": "/subscriptions/subid/resourceGroups/testRG/providers/Microsoft.HealthcareApis/workspaces/workspace1/iotconnectors/blue/fhirdestinations/dest1",
  "type": "Microsoft.HealthcareApis/workspaces/iotconnectors/fhirdestinations",
  "location": "West US 2",
  "etag": "00000000-0000-0000-f5ac-912ca49e01d6",
  "properties": {
    "provisioningState": "Accepted",
    "resourceIdentityResolutionType": "Create",
    "fhirServiceResourceId": "subscriptions/11111111-2222-3333-4444-555566667777/resourceGroups/myrg/providers/Microsoft.HealthcareApis/workspaces/myworkspace/fhirservices/myfhirservice",
    "fhirMapping": {
      "content": {
        "templateType": "CollectionFhirTemplate",
        "template": [
          {
            "templateType": "CodeValueFhir",
            "template": {
              "codes": [
                {
                  "code": "8867-4",
                  "system": "http://loinc.org",
                  "display": "Heart rate"
                }
              ],
              "periodInterval": 60,
              "typeName": "heartrate",
              "value": {
                "defaultPeriod": 5000,
                "unit": "count/min",
                "valueName": "hr",
                "valueType": "SampledData"
              }
            }
          }
        ]
      }
    }
  },
  "systemData": {
    "createdBy": "string",
    "createdAt": "2021-01-28T19:26:24.072Z",
    "lastModifiedBy": "string",
    "lastModifiedAt": "2021-01-28T19:26:24.072Z"
  }
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorDetails	Detalles del error.
ErrorDetailsInternal	Detalles del error.
IotFhirDestination	Definición de destino de FHIR del conector de IoT.
IotIdentityResolutionType	Tipo de resolución de identidad de IoT que se va a usar con el destino.
IotMappingProperties	Contenido de asignación.
systemData	Metadatos relativos a la creación y última modificación del recurso.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

ErrorDetails

Object

Detalles del error.

Nombre	Tipo	Description
error	ErrorDetailsInternal	Detalles del error

ErrorDetailsInternal

Object

Detalles del error.

Nombre	Tipo	Description
code	string	Código de error.
message	string	Mensaje de error.
target	string	Destino del error concreto.

IotFhirDestination

Object

Definición de destino de FHIR del conector de IoT.

Nombre	Tipo	Description
etag	string	ETAG asociado al recurso, que se usa para la simultaneidad optimista al editarlo.
id	string	Identificador de recurso.
location	string	Ubicación del recurso.
name	string pattern: ^[a-z0-9][a-z0-9-]{1,21}[a-z0-9]$	Nombre del recurso.
properties.fhirMapping	IotMappingProperties	Asignaciones de FHIR
properties.fhirServiceResourceId	string	Identificador de recurso completo del servicio FHIR al que conectarse.
properties.resourceIdentityResolutionType	IotIdentityResolutionType	Determina cómo se resuelve la identidad de recursos en el destino.
systemData	systemData	Metadatos relativos a la creación y última modificación del recurso.
type	string	Tipo de recurso.

IotIdentityResolutionType

Enumeración

Tipo de resolución de identidad de IoT que se va a usar con el destino.

Valor	Description
Create
Lookup

IotMappingProperties

Object

Contenido de asignación.

Nombre	Tipo	Description
content	object	Asignación.

systemData

Object

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.