Extensiones primitivas FHIR en JSON

Explica cómo representar valores primitivos y sus metadatos de extensión en FHIR JSON, incluidos los compañeros primitivos de nivel superior disponibles en los recursos soportados FHIR R4 (4.0.1) y R6 4 (6.0.0-ballot4).

Descripción general

Un elemento primitivo FHIR puede tener un valor y metadatos de elemento adicionales. En JSON, estas dos partes utilizan propiedades hermanas independientes:

  • element contiene el valor primitivo, como una cadena, un booleano, un número, una fecha o un código.
  • _element contiene las extensiones y id opcionales del elemento primitivo. Este nivel de elemento id es distinto del nivel lógico Resource.id del recurso.

Por ejemplo, status contiene el valor primitivo y _status contiene metadatos que se aplican a ese mismo elemento lógico. Incluya el acompañante de guion bajo solo cuando el primitivo tenga metadatos de extensión o id.

Reglas de compañía primitivas

  • Si un primitivo tiene un valor y metadatos, incluya tanto la propiedad value como su acompañante de guion bajo.
  • Un objeto complementario de guion bajo no puede estar vacío.
  • Si un primitivo tiene metadatos de extensión pero no un valor primitivo, omita la propiedad value e incluya el guion bajo complementario. El acompañante debe contener una extensión; un id por sí solo no es suficiente cuando el valor está ausente.
  • Cada objeto de extensión requiere un url que identifique su StructureDefinition aplicable. Use una definición de extensión válida para la versión de FHIR o la guía de implantación seleccionada.
  • Cada objeto de extensión contiene una matriz extension anidada o exactamente una propiedad value[x] concreta, como valueString o valueCode. No puede contener ambos.
  • Utilice una extensión sólo cuando la información no pueda ser representada por un elemento FHIR básico adecuado.

Valor primitivo con metadatos de extensión

Este paciente incluye un valor birthDate y un complemento _birthDate con la extensión de valor representado HL7 estándar:

{
  "resourceType": "Patient",
  "identifier": [
    {
      "system": "urn:ddfs:documentation-sample",
      "value": "primitive-value-metadata-example"
    }
  ],
  "birthDate": "1990-03-09",
  "_birthDate": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/rendered-value",
        "valueString": "March 9, 1990"
      }
    ]
  }
}
  • identifier.system identifica el espacio de nombres que rige un identificador de paciente.
  • extension.url identifica la definición de extensión.

El sistema de identificadores y el valor de este ejemplo no son valores definidos por DDFS. Sustituya estos valores por un espacio de nombres de identificador y un valor para su organización.

Utilice URL de extensión y valores definidos por la versión de FHIR aplicable o una guía de implantación que admita la integración.

Metadatos de extensión sin valor primitivo

Un primitivo puede tener metadatos de extensión incluso cuando su valor no está disponible. En este ejemplo, se omite birthDate y _birthDate lleva la extensión:

{
  "resourceType": "Patient",
  "identifier": [
    {
      "system": "urn:ddfs:documentation-sample",
      "value": "extension-only-example"
    }
  ],
  "_birthDate": {
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
        "valueCode": "unknown"
      }
    ]
  }
}

Elementos primitivos repetitivos

Para un primitivo de repetición, los valores y sus metadatos utilizan dos matrices alineadas posicionalmente. Utilice un marcador de posición null de JSON en la matriz de valores cuando un elemento tenga metadatos de extensión pero no un valor primitivo. Utilice null en la matriz de guiones bajos cuando el valor correspondiente no tenga ninguna extensión o id.

El segundo elemento given de este ejemplo de HumanName tiene tanto el valor J. como los metadatos de extensión. La primera entrada de _given es null porque Avery no tiene metadatos primitivos:

{
  "resourceType": "Patient",
  "identifier": [
    {
      "system": "urn:ddfs:documentation-sample",
      "value": "repeating-primitives-example"
    }
  ],
  "name": [
    {
      "family": "Chen",
      "given": [
        "Avery",
        "J."
      ],
      "_given": [
        null,
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/iso21090-EN-qualifier",
              "valueCode": "IN"
            }
          ]
        }
      ]
    }
  ]
}

No omita un marcador de posición en el centro de ninguna de las matrices. Al cambiar su posición, los metadatos se asocian a un valor primitivo diferente.

Errores de validación

DDFS rechazó una solicitud de creación de paciente que representaba _birthDate como una cadena en lugar de un objeto. Tanto los puntos finales de la boleta electoral R4 como R6 de 4 devolvieron el estado HTTP 400 con un FHIR OperationOutcome. Corrija la representación del acompañante primitivo y utilice los problemas del Resultado de operación devuelto para identificar el elemento afectado antes de reintentarlo.

Compañeros primitivos de nivel superior por recurso

Las siguientes matrices muestran los compañeros de guion bajo para las propiedades primitivas de nivel superior en cada modelo de recursos DDFS soportado. Un acompañante enumerado es opcional y se incluye solo cuando su elemento primitivo correspondiente tiene metadatos de extensión o id.

Las propiedades primitivas dentro de tipos de datos anidados y elementos de columna vertebral también pueden tener compañeros de subrayado. Estas propiedades anidadas siguen las mismas reglas JSON de FHIR, pero están fuera del ámbito de estas matrices.

Compañeros primitivos de nivel superior R4

Recurso Propiedades de compañía primitivas
Condición _implicitRules, _language, _onsetDateTime, _onsetString, _abatementDateTime, _abatementString, _recordedDate
MedicationStatement _implicitRules, _language, _status, _effectiveDateTime, _dateAsserted
Dispositivo _implicitRules, _language, _status, _distinctIdentifier, _manufacturer, _manufactureDate, _expirationDate, _lotNumber, _serialNumber, _modelNumber, _partNumber, _url
DiagnosticReport _conclusion, _effectiveDateTime, _implicitRules, _issued, _language, _status
Episodio clínico _implicitRules, _language, _status
Punto final _address, _header, _implicitRules, _language, _name, _payloadMimeType, _status
Grupo _active, _actual, _implicitRules, _language, _name, _quantity, _type
Ubicación _alias, _availabilityExceptions, _description, _implicitRules, _language, _mode, _name, _status
Observación _implicitRules, _language, _status, _effectiveDateTime, _effectiveInstant, _issued, _valueString, _valueBoolean, _valueInteger, _valueTime, _valueDateTime
Organización _implicitRules, _language, _active, _name, _alias
Paciente _implicitRules, _language, _active, _gender, _birthDate, _deceasedBoolean, _deceasedDateTime, _multipleBirthBoolean, _multipleBirthInteger
Profesional _implicitRules, _language, _active, _gender, _birthDate
Rol de practicante _active, _availabilityExceptions, _implicitRules, _language
Procedencia _implicitRules, _language, _occurredDateTime, _policy, _recorded
Persona allegada _active, _birthDate, _gender, _implicitRules, _language
Solicitud de servicio _asNeededBoolean, _authoredOn, _doNotPerform, _implicitRules, _instantiatesCanonical, _instantiatesUri, _intent, _language, _occurrenceDateTime, _patientInstruction, _priority, _status
Muestra _implicitRules, _language, _receivedTime, _status

R6 4 compañeros primitivos de alto nivel

Recurso Propiedades de compañía primitivas
Dispositivo _implicitRules, _language, _status, _manufacturer, _manufactureDate, _expirationDate, _lotNumber, _serialNumber, _modelNumber, _partNumber
Asociación de dispositivo _implicitRules, _language, _status
Episodio clínico _implicitRules, _language, _plannedEndDate, _plannedStartDate, _status
Ubicación _alias, _description, _implicitRules, _language, _mode, _name, _status
Observación _implicitRules, _language, _status, _organizer, _effectiveDateTime, _effectiveInstant, _issued, _valueString, _valueBoolean, _valueInteger, _valueTime, _valueDateTime
Paciente _implicitRules, _language, _active, _gender, _birthDate, _deceasedBoolean, _deceasedDateTime, _multipleBirthBoolean, _multipleBirthInteger
Profesional _implicitRules, _language, _active, _gender, _birthDate, _deceasedBoolean, _deceasedDateTime
Rol de practicante _active, _display, _implicitRules, _language
Procedencia _implicitRules, _language, _occurredDateTime, _policy, _recorded, _why
Suscripción _content, _contentType, _end, _endpoint, _heartbeatPeriod, _implicitRules, _language, _maxCount, _name, _reason, _status, _timeout
Tema de suscripción _approvalDate, _copyright, _copyrightLabel, _date, _description, _experimental, _implicitRules, _language, _lastReviewDate, _name, _publisher, _purpose, _status, _title, _url, _version, _versionAlgorithmString

Extensión de OCI Vault de suscripción

La extensión secreta de OCI Vault de suscripción a DDFS es una extensión regular en la matriz raíz Subscription.extension. No son metadatos primitivos y no utilizan un acompañante de guion bajo. Consulte FHIR R6 Subscription OCI Vault Secret Extension.

Especificaciones de JSON de FHIR

Para obtener más información sobre las reglas de representación JSON específicas de la versión, consulte: