Pular para o conteúdo principal

Cadastrar/atualizar

Endpoint

POST /fhir/resources/Practitioner

Autenticação🔓 Chave de API
StatusImplementado

Modelagem da API - Request​

OpçãoTipoRequeridoDescriçãoExemplo
x-api-keystringSim

Chave de autenticação do cliente, fornecida durante a configuração do ambiente.

Content-TypestringSimapplication/json


Exemplo de requisição CURL

curl --request POST \
--url https://landing-zone-api.nilo.services/fhir/resources/Practitioner \
--header 'Content-Type: application/json' \
--header 'x-api-key: ???' \
--data '{
"resourceType": "Practitioner",
"identifier": [
	{
		"use": "usual",
		"system": "https://www.4devs.com.br/gerador_de_pessoas/",
		"value": "507823709"
	},
	{
		"use": "official",
		"system": "https://servicos.receita.fazenda.gov.br/servicos/cpf/",
		"value": "57978394824"
	}
],
}'
Exemplo de requisição CURL com email para login

curl --request POST \
--url https://landing-zone-api.nilo.services/fhir/resources/Practitioner \
--header 'Content-Type: application/json' \
--header 'x-api-key: ???' \
--data '{
"resourceType": "Practitioner",
"active": true,
"identifier": [
  {
    "system": "https://servicos.receita.fazenda.gov.br/servicos/cpf/",
    "use": "official",
    "value": "19615344010"
  }
],
"name": [
  {
    "text": "Nome do Profissional",
    "use": "official"
  }
],
"extension": [
  {
    "url": "https://landing-zone-api.dev.nilo.services/fhir/resources/StructureDefinition/practitioner-user",
    "extension": [
      {
        "url": "https://landing-zone-api.dev.nilo.services/fhir/resources/StructureDefinition/practitioner-user-active",
        "valueBoolean": true
      },
      {
        "url": "https://landing-zone-api.dev.nilo.services/fhir/resources/StructureDefinition/practitioner-user-email",
        "valueString": "email@exemplo.com"
      }
    ]
  }
]
}'


Modelagem da API - Response​

Operação bem sucedida.

Array of Extension-Practitioner-user (object)

Pode ser usado para representar informações adicionais que não fazem parte da definição básica do recurso. Qualquer implementador pode definir uma extensão, aqui apresentamos as extensões utilizadas no contexto Nilo, extensões externas a esse contexto são ignoradas.

gender
string
Enum: "male" "female" "other" "unknown"

O sexo que o profissional de saúde é considerado para fins de administração e manutenção de registros.

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.

Array of objects (Identifier)

Um conjunto de códigos de identificação para este profissional de saúde (IDs, CPF, CRM, ...).

object (Meta)

Os metadados sobre um recurso. Este conteúdo do recurso é normalmente mantido pelo sistema gestor do registro.

required
Array of objects (HumanName)

O(s) nome(s) associado(s) ao profissional de saúde. Ao menos um nome official deve ser fornecido.

resourceType
required
string
Default: "Practitioner"

Indica o tipo do recurso transacionado.

Array of objects (ContactPoint)

Um detalhe de contato (por exemplo, um número de telefone ou um endereço de e-mail) por qual o indivíduo pode ser contatado.

{
  • "extension": [
    ],
  • "gender": "male",
  • "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
  • "identifier": [
    ],
  • "meta": {
    },
  • "name": [
    ],
  • "resourceType": "Practitioner",
  • "telecom": [
    ]
}