Pular para o conteúdo principal

Cadastrar/atualizar

EndpointPOST /fhir/resources/Patient
Autenticação🔓 Chave de API
StatusImplementado

Modelagem da API - Request​

OpçãoTipoRequeridoDescriçãoExemplo
x-api-keystringSimChave 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/Patient \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: ???' \
  --data '{
  "resourceType": "Patient",
  "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"
    }
  ],
  "active": true,
  "name": [
    {
      "use": "official",
      "text": "Valentina Luna Maitê Nunes"
    },
    {
      "use": "usual",
      "text": "Nome Social ou Apelido"
    }
  ],
  "gender": "female",
  "birthDate": "1989-01-04"
}'
Removendo nome social ou apelido

curl --request POST \
  --url https://landing-zone-api.nilo.services/fhir/resources/Patient \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: ???' \
  --data '{
  "resourceType": "Patient",
  "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"
    }
  ],
  "active": true,
  "name": [
    {
      "use": "official",
      "family": "Silva",
      "given": [
        "João"
      ]
    },
    {
      "use": "usual",
      "text": "Nome Social ou Apelido",
      "period": {
        "end": "2021-01-01"
      }
    }
  ],
  "gender": "female",
  "birthDate": "1989-01-04"
}'


Modelagem da API - Response​

Operação bem sucedida.
active
boolean^true|false$

Se o registro deste paciente está em uso ativo

Array of objects (Address)

O(s) endereço(s) para o indivíduo.

birthDate
string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

A data de nascimento do indivíduo.

Array of objects (Patient_Communication)

Uma linguagem que pode ser usada para se comunicar com o paciente sobre sua saúde.

deceasedBoolean
boolean^true|false$

Indica se o indivíduo é falecido ou não.

deceasedDateTime
string^([0-9]([0-9]([0-9][1-9]|[1-9]0)|[1-9]00)|[1-...

A data e hora do falecimento do indivíduo.

Array of Extension-Patient-cohort (object) or Extension-Patient-cadavericDonor (object) or Extension-Patient-genderIdentity (object) or Extension-Patient-religion (object) or Extension-Patient-isLead (object) or Extension-Patient-sendWelcomingMessage (object) or Extension-Patient-createOnboardingScheduling (object) or Extension-Patient-status (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 paciente é 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.

required
Array of objects (Identifier) non-empty

Um conjunto de códigos de identificação para este paciente (IDs, CPF, RG, ...). Ao menos um identificador usado como CPF ou identificador externo é obrigatório e deve ser único, as regras de namespace para leitura e escrita são definidas durante a implantação.

object

Organização, departamento ou sub-departamento guardiã do prontuário do paciente.

object

Estado civil de um paciente

object (Meta)

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

Array of objects (HumanName)

O(s) nome(s) associado(s) ao paciente.

resourceType
required
string
Default: "Patient"

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. Atenção: números de telefone sem alta confiança é recomendado enviar com use old ou temp, desse modo não sobrescreverá outros que possam ser mais atualizados.

{
  • "active": true,
  • "address": [
    ],
  • "birthDate": "1974-12-25",
  • "communication": {
    },
  • "deceasedBoolean": true,
  • "deceasedDateTime": "2015-02-07T13:28:17",
  • "extension": [],
  • "gender": "male",
  • "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
  • "identifier": [
    ],
  • "managingOrganization": {
    },
  • "maritalStatus": {},
  • "meta": {
    },
  • "name": [
    ],
  • "resourceType": "Patient",
  • "telecom": [
    ]
}