Cadastrar ou atualizar | Nilo Saúde · Interoperabilidade FHIR

curl -X POST https://landing-zone-api.nilo.services/fhir/resources/Observation \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "code": {
    "coding": [
      {
        "code": "82810-3",
        "display": "Pregnancy status",
        "system": "http://loinc.org"
      }
    ]
  },
  "resourceType": "Observation",
  "status": "final",
  "subject": {
    "identifier": {
      "system": "https://www.acmesaude.com.br/integracao/paciente/",
      "value": "507823709",
      "use": "usual"
    },
    "type": "Patient"
  },
  "valueCodeableConcept": {
    "coding": [
      {
        "code": "prenatal",
        "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/pregnancy-status"
      },
      {
        "code": "LA15173-0",
        "display": "Pregnant",
        "system": "http://loinc.org"
      }
    ]
  },
  "component": [
    {
      "code": {
        "coding": [
          {
            "code": "8665-2",
            "display": "Last menstrual period start date",
            "system": "http://loinc.org"
          }
        ]
      },
      "valueDateTime": "2026-03-01"
    },
    {
      "code": {
        "coding": [
          {
            "code": "risk",
            "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/pregnancy-observation"
          }
        ]
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "high",
            "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/pregnancy-risk"
          }
        ]
      }
    },
    {
      "code": {
        "coding": [
          {
            "code": "57722-1",
            "display": "Birth plurality of Pregnancy",
            "system": "http://loinc.org"
          }
        ]
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "twins",
            "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/pregnancy-type"
          }
        ]
      }
    }
  ],
  "identifier": [
    {
      "system": "https://www.acmesaude.com.br/integracao/gestacao/",
      "value": "3318",
      "use": "usual"
    }
  ]
}'

{
  "code": {
    "coding": [
      {
        "code": "82810-3",
        "display": "Pregnancy status",
        "system": "http://loinc.org"
      }
    ]
  },
  "resourceType": "Observation",
  "status": "final",
  "subject": {
    "identifier": {
      "system": "https://www.acmesaude.com.br/integracao/paciente/",
      "value": "507823709",
      "use": "usual"
    },
    "type": "Patient",
    "reference": "Patient/ba200cfa-dae0-46cf-81a0-008e3f7414b4"
  },
  "valueCodeableConcept": {
    "coding": [
      {
        "code": "prenatal",
        "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/pregnancy-status"
      },
      {
        "code": "LA15173-0",
        "display": "Pregnant",
        "system": "http://loinc.org"
      }
    ]
  },
  "component": [
    {
      "code": {
        "coding": [
          {
            "code": "8665-2",
            "display": "Last menstrual period start date",
            "system": "http://loinc.org"
          }
        ]
      },
      "valueDateTime": "2026-03-01"
    },
    {
      "code": {
        "coding": [
          {
            "code": "11778-8",
            "display": "Delivery date Estimated",
            "system": "http://loinc.org"
          }
        ]
      },
      "valueDateTime": "2026-12-06"
    },
    {
      "code": {
        "coding": [
          {
            "code": "risk",
            "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/pregnancy-observation"
          }
        ]
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "high",
            "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/pregnancy-risk"
          }
        ]
      }
    },
    {
      "code": {
        "coding": [
          {
            "code": "57722-1",
            "display": "Birth plurality of Pregnancy",
            "system": "http://loinc.org"
          }
        ]
      },
      "valueCodeableConcept": {
        "coding": [
          {
            "code": "twins",
            "system": "https://landing-zone-api.nilo.services/fhir/resources/CodeSystem/pregnancy-type"
          }
        ]
      }
    }
  ],
  "effectivePeriod": {
    "start": "2026-03-01"
  },
  "id": "5e2d9a41-7c3b-4f08-9b6e-2a1f4c8d7e53",
  "identifier": [
    {
      "system": "https://landing-zone-api.nilo.services/fhir/resources/NamingSystem/hippocrates-api--pregnancy",
      "value": "18342",
      "use": "usual"
    },
    {
      "system": "https://www.acmesaude.com.br/integracao/gestacao/",
      "value": "3318",
      "use": "usual"
    }
  ]
}

Cria a gestação quando nenhum identifier do payload casa com uma gestação existente, e atualiza a encontrada caso contrário. Só a gestação é aceita: o code tem de trazer o LOINC 82810-3 (Pregnancy status), e qualquer outro tipo de observação é recusado.

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

codeobjectRequired

O tipo de observação. Precisa trazer o coding http://loinc.org|82810-3, em qualquer posição de coding; é ele que roteia a escrita para a gestação.

resourceTypestringRequiredDefaults to Observation

Indica o tipo do recurso transacionado.

statusenumRequired

Status do registro da observação, não da gestação. Aceita final, amended, corrected e preliminary, sem efeito na gravação; na leitura é sempre final.

Allowed values:

subjectobjectRequired

Paciente a quem a gestação pertence, por um identificador dela.

valueCodeableConceptobjectRequired

O status da gestação: um coding no system {host}/fhir/resources/CodeSystem/pregnancy-status com prenatal, postpartum ou abortion. Um coding LOINC (LA15173-0 ou LA26683-5) é opcional e, se vier, tem de concordar com o status.

componentlist of objectsOptional

Os dados da gestação, um component por dado, reconhecidos pelo code: DUM (8665-2), DPP (11778-8, só resposta), data do parto (93857-1), risco (risk no system {host}/fhir/resources/CodeSystem/pregnancy-observation) e tipo (57722-1). Um component ausente mantém o valor já gravado.

effectivePeriodobjectOptional

Período da gestação. Na escrita, start é lido como DUM quando não vem o component 8665-2, e end é a data de encerramento, recusada em prenatal. Na leitura, start traz a DUM ou, sem ela, a data em que a gestação foi criada na plataforma. É o único effective[x] aceito.

idstringOptionalformat: "^[A-Za-z0-9\-\.]{1,64}$"

Só resposta: o identificador Nilo FHIR do recurso.

identifierlist of objectsOptional

Identificadores da gestação. É por aqui que a escrita decide entre criar e atualizar. Na leitura vem também o identificador Nilo, no system {host}/fhir/resources/NamingSystem/hippocrates-api--pregnancy.

metaobjectOptional

Só resposta: metadados da gravação no store FHIR.

Response

Recurso criado/atualizado com sucesso.

codeobject

O tipo de observação. Precisa trazer o coding http://loinc.org|82810-3, em qualquer posição de coding; é ele que roteia a escrita para a gestação.

resourceTypestringDefaults to Observation

Indica o tipo do recurso transacionado.

statusenum