Pular para o conteúdo principal

Cadastrar/Atualizar

EndpointPOST /fhir/resources/Group
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/Group \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: ???' \
  --data '
{
"active": false,
"actual": true,
"identifier": [
  {
    "system": "https://sistema.externo.com.br/cohort",
    "use": "usual",
    "value": "ca303a51-e82e-4041-9fbf-c3b4b4d4f695"
  }
],
"managingEntity": {
  "identifier": {
    "system": "https://sistema.externo.com.br/organization",
    "use": "usual",
    "value": "1"
  },
  "type": "Organization"
},
"name": "Teste Escrita cohort",
"resourceType": "Group",
"type": "person"
}
'


Modelagem da API - Response​

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.

Array of objects (Extension)
required
Array of objects (Identifier)
active
required
boolean (boolean) ^true|false$

Valor de "verdadeiro" ou "falso".

type
any
Enum: "person" "animal" "practitioner" "device" "medication" "substance"

Usar sempre person

actual
boolean (boolean) ^true|false$

Valor de "verdadeiro" ou "falso".

object (CodeableConcept)

Um CodeableConcept representa um valor geralmente fornecido como uma referência a terminologias ou ontologias, mas também pode ser definido pelo fornecimento de texto. Esse é um padrão comum em dados de saúde.

name
string (string) ^[ \r\n\t\S]+$

Uma sequência de caracteres.

quantity
number (unsignedInt) ^[0]|([1-9][0-9]*)$

An integer with a value that is not negative (e.g. >= 0)

object (Reference)

Uma referência de um recurso para outro.

Array of objects (Group_Characteristic)
Array of objects (Group_Member)
{
  • "resourceType": "Group",
  • "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
  • "meta": {
    },
  • "extension": [
    ],
  • "identifier": [
    ],
  • "active": true,
  • "type": "person",
  • "actual": true,
  • "code": {
    },
  • "name": "string",
  • "quantity": 0,
  • "managingEntity": {
    },
  • "characteristic": [
    ],
  • "member": [
    ]
}