Cadastrar/Atualizar

Endpoint	POST /fhir/resources/Group
Autenticação	🔓 Chave de API
Status	Implementado

Modelagem da API - Request

---

Headers

Opção	Tipo	Requerido	Descrição				Exemplo
x-api-key	string	Sim	Chave de autenticação do cliente, fornecida durante a configuração do ambiente.
Content-Type	string	Sim					application/json

Body

resourceType required	any Value: "Group"
id	string (id) ^[A-Za-z0-9\-\.]{{1,64}}$ Qualquer combinação de letras, números, "-" e ".", com um limite de 64 caracteres. (Pode ser um número inteiro, um OID não prefixado, UUID ou qualquer outro padrão de identificador que atenda a essas restrições.) Os IDs não diferenciam maiúsculas de minúsculas.
	object (Meta) Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro.
required	Array of objects (Identifier)
active required	any Value: true
type required	any Value: "person"
actual required	any Value: true
name required	string (string) ^[ \r\n\t\S]+$ Uma sequência de caracteres.

{

• "resourceType": "Group",
• "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
• "meta": {

  • "lastUpdated": "2022-05-25T18:42:06.551129+00:00",
  • "versionId": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81"

  },
• "identifier": [

  • {

    • "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
    • "use": "usual",
    • "value": "12345"

    }

  ],
• "active": true,
• "type": "person",
• "actual": true,
• "name": "string"

}

Exemplo de requisição CURL

curl --request POST \
  --url https://landing-zone-api.nilo.services/fhir/resources/Group \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <inserir API Key aqui>' \
  --data '
{
"active": true,
"actual": true,
"identifier": [
  {
    "system": "https://sistema.externo.com.br/cohort",
    "use": "usual",
    "value": "ca303a51-e82e-4041-9fbf-c3b4b4d4f695"
  }
],
"name": "Teste Escrita cohort",
"resourceType": "Group",
"type": "person"
}
'
  

Modelagem da API - Response

---

✔ 200

Operação bem sucedida.

resourceType required	any Value: "Group"
id	string (id) ^[A-Za-z0-9\-\.]{{1,64}}$ Qualquer combinação de letras, números, "-" e ".", com um limite de 64 caracteres. (Pode ser um número inteiro, um OID não prefixado, UUID ou qualquer outro padrão de identificador que atenda a essas restrições.) Os IDs não diferenciam maiúsculas de minúsculas.
	object (Meta) Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro.
required	Array of objects (Identifier)
active required	any Value: true
type required	any Value: "person"
actual required	any Value: true
name required	string (string) ^[ \r\n\t\S]+$ Uma sequência de caracteres.

{

• "resourceType": "Group",
• "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
• "meta": {

  • "lastUpdated": "2022-05-25T18:42:06.551129+00:00",
  • "versionId": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81"

  },
• "identifier": [

  • {

    • "system": "{host}/fhir/resources/NamingSystem/hippocrates-api--model-name",
    • "use": "usual",
    • "value": "12345"

    }

  ],
• "active": true,
• "type": "person",
• "actual": true,
• "name": "string"

}

✘ 400

Parâmetro enviado inválido.

required	Array of objects Uma coleção de mensagens de erro, aviso ou informação que resultado de uma ação do sistema.
resourceType required	string Default: "OperationOutcome" Indica o tipo do recurso transacionado.

{

• "issue": [

  • {

    • "code": "exception",
    • "details": {

      • "text": "Parâmetro enviado inválido"

      },
    • "severity": "error"

    }

  ],
• "resourceType": "OperationOutcome"

}

✘ 500

Erro inesperado.