Pular para o conteúdo principal

Cadastrar/Atualizar

EndpointPOST /fhir/resources/Flag
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/Flag \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: ???' \
  --data '
{
  "resourceType": "Flag",
  "identifier": [
      {
          "system": "http://sistemaorigem.cliente.com/flag",
          "value": "12345"
      }
  ],
  "status": "active",
  "code": {
      "coding": [
          {
              "system": "https://landing-zone-api.dev.nilo.services/fhir/resources/CodeSystem/flag-code",
              "code": "79"
          }
      ]
  },
  "subject": {
      "identifier": {
          "system": "https://servicos.receita.fazenda.gov.br/servicos/cpf/",
          "use": "official",
          "value": ""
      },
      "type": "Patient"
  }
}'


Modelagem da API - Response​

Operação bem sucedida.
resourceType
required
any
Value: "Flag"
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.

implicitRules
string (uri) ^\S*$

Uma referência de identificador de recurso uniforme (RFC 3986) usado como "namespace".

object (Element)
language
string (code) ^[^\s]+(\s[^\s]+)*$

Indica que o valor é obtido de um conjunto de strings controladas definidas em uma listagem.

object (Element)
object (Narrative)
Array of objects (Resource)
Array of objects (Extension)
Array of objects (Extension)
Array of objects (Identifier)
status
any
Enum: "active" "inactive" "entered-in-error"
object (Element)
Array of objects (CodeableConcept)
required
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.

required
object (Reference)

Uma referência de um recurso para outro.

object (Period)

Um intervalo de tempo definido por uma data de início e término e, opcionalmente, horas para ambos.

object (Reference)

Uma referência de um recurso para outro.

object (Reference)

Uma referência de um recurso para outro.

{
  • "resourceType": "Flag",
  • "id": "903dAAe9-c57f-4eb3-bd1c-65XXd41exx81",
  • "meta": {
    },
  • "implicitRules": "string",
  • "_implicitRules": {
    },
  • "language": "string",
  • "_language": {
    },
  • "text": {
    },
  • "contained": [
    ],
  • "extension": [
    ],
  • "modifierExtension": [
    ],
  • "identifier": [
    ],
  • "status": "active",
  • "_status": {
    },
  • "category": [
    ],
  • "code": {
    },
  • "subject": {
    },
  • "period": {
    },
  • "encounter": {
    },
  • "author": {
    }
}