Solicitudes y respuestas de API de FHIR R4
Utilice las interacciones de FHIR R4 (4.0.1) y los parámetros de búsqueda anunciados por la sentencia de capacidad DDFS desplegada.
Confirmación de las capacidades de R4 desplegadas
Llame a GET {base}/api/fhir/r4/metadata. Utilice el valor CapabilityStatement devuelto como autoridad para los recursos, interacciones, operaciones y parámetros de búsqueda disponibles en la instancia de DDFS desplegada.
Patrones comunes
- Buscar:
GET /api/fhir/r4/<Resource>?<query-parameters> - Crear:
POST /api/fhir/r4/<Resource> - Lea:
GET /api/fhir/r4/<Resource>/{rid} - Actualización:
PUT /api/fhir/r4/<Resource>/{rid} - Versión leída:
GET /api/fhir/r4/<Resource>/{rid}/_history/{vid} - Supresión lógica:
DELETE /api/fhir/r4/<Resource>/{rid}
Un DELETE estándar es una supresión lógica. POST /api/fhir/r4/<Resource>/{rid}/$hardDelete suprime permanentemente un recurso suprimido de forma lógica elegible. POST /api/fhir/r4/<Resource>/$purgeDeleted suprime permanentemente los recursos suprimidos lógicamente elegibles seleccionados por sus entradas. Ambas operaciones administrativas son irreversibles y requieren autorización adicional.
Búsqueda y paginación
Los controles comunes anunciados incluyen _count, _total, _id, _lastUpdated, _profile y _tag. Confirme cada control para el recurso de destino.
- Tratar
_countcomo un tamaño máximo de página solicitado; una página puede contener menos entradas. Bundle.totales opcional, incluso cuando se solicita un modo_totalsoportado.- Siga la URL en
Bundle.linkcuya relación esnextliteralmente. No cree ni edite la URL de paginación. - Repita un nombre de parámetro instantáneo o de fecha real para expresar un rango soportado, por ejemplo,
birthdate=ge1980-01-01&birthdate=le1990-12-31.
Las URL de búsqueda de FHIR pueden contener PHI. Consulte Protect Sensitive Search Data.
Condición
Buscar: GET /api/fhir/r4/Condition
Advertised parameters include _count, _total, _id, _lastUpdated, _profile, _tag, abatement-date, category, clinical-status, code, encounter, onset-date, patient, and recorded-date.
Ejemplo de solicitud
GET /api/fhir/r4/Condition?_id={rid}&patient=Patient/{patient-id}
Ejemplo de respuesta
{"resourceType":"Bundle","type":"searchset","entry":[{"resource":{"resourceType":"Condition"}}]}
Crear ejemplo
POST /api/fhir/r4/Condition
Content-Type: application/fhir+json
{
"resourceType": "Condition",
"code": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "44054006",
"display": "Diabetes mellitus type 2"
}
]
},
"subject": {"reference": "Patient/{rid}"}
}
Dispositivo
Buscar: GET /api/fhir/r4/Device
Los parámetros anunciados incluyen controles comunes, además de patient, status, type, manufacturer y model.
Ejemplo de solicitud
GET /api/fhir/r4/Device?patient=Patient/{rid}&status=active
Ejemplo de respuesta
{"resourceType":"Bundle","type":"searchset","entry":[{"resource":{"resourceType":"Device"}}]}
DiagnosticReport
Buscar: GET /api/fhir/r4/DiagnosticReport
Los parámetros anunciados incluyen controles comunes, además de category, code, date, patient y status.
Ejemplo de solicitud
GET /api/fhir/r4/DiagnosticReport?patient=Patient/{rid}&date=ge2024-01-01
Ejemplo de respuesta
{"resourceType":"Bundle","type":"searchset","entry":[{"resource":{"resourceType":"DiagnosticReport"}}]}
Episodio clínico
Buscar: GET /api/fhir/r4/Encounter
Los parámetros anunciados incluyen controles comunes, además de class, date, discharge-disposition, identifier, location, patient, status y type.
Ejemplo de solicitud
GET /api/fhir/r4/Encounter?patient=Patient/{rid}&status=in-progress
Ejemplo de respuesta
{"resourceType":"Bundle","type":"searchset","entry":[{"resource":{"resourceType":"Encounter"}}]}
Ubicación
Buscar: GET /api/fhir/r4/Location
Los parámetros anunciados incluyen controles comunes, además de identifier, status, partof, name, address, address-city, address-state y address-postalcode.
Ejemplo de solicitud
GET /api/fhir/r4/Location?address-city=Boston&name=Main
Ejemplo de respuesta
{"resourceType":"Bundle","type":"searchset","entry":[{"resource":{"resourceType":"Location"}}]}
Paciente
Buscar: GET /api/fhir/r4/Patient
Los parámetros anunciados incluyen controles comunes, además de birthdate, death-date, family, given, identifier y name.
Ejemplo de solicitud
GET /api/fhir/r4/Patient?family=Doe&birthdate=ge1980-01-01&birthdate=le1990-12-31
Ejemplo de respuesta
{"resourceType":"Bundle","type":"searchset","entry":[{"resource":{"resourceType":"Patient"}}]}
Profesional
Buscar: GET /api/fhir/r4/Practitioner
Los parámetros anunciados incluyen controles comunes más identifier y name.
Ejemplo de solicitud
GET /api/fhir/r4/Practitioner?name=Smith
Ejemplo de respuesta
{"resourceType":"Bundle","type":"searchset","entry":[{"resource":{"resourceType":"Practitioner"}}]}
Otros Recursos
Para Endpoint, Group, Observation, Organization, PractitionerRole, Provenance, RelatedPerson, ServiceRequest, Specimen y cualquier otro recurso R4 anunciado, utilice la página de recursos aplicable y la declaración de capacidad desplegada para la lista exacta de interacciones, operaciones y parámetros de búsqueda.
Códigos de Estado
| Código | Significado |
|---|---|
| 200 | Se ha completado correctamente una operación personalizada de lectura, búsqueda, actualización, lectura con versiones o documentada. |
| 201 | El recurso ha sido creado correctamente. |
| 204 | El recurso se ha suprimido de forma lógica correctamente y la respuesta no tiene cuerpo. |