Solicitudes y respuestas de API de FHIR R6
Use las interacciones de recursos y los parámetros de búsqueda de la boleta electoral4 (6.0.0-ballot4) de FHIR R6 anunciados por la sentencia de capacidad DDFS desplegada.
Confirmación de las capacidades desplegadas de R6
Llame a GET {base}/api/fhir/r6-ballot4/metadata. Utilice el CapabilityStatement devuelto como autoridad para la instancia de DDFS desplegada; no infiera soporte de R6 de la superficie de R4 ni de otro entorno.
Patrones comunes
- Buscar:
GET /api/fhir/r6-ballot4/<Resource>?<query-parameters> - Crear:
POST /api/fhir/r6-ballot4/<Resource> - Lea:
GET /api/fhir/r6-ballot4/<Resource>/{rid} - Actualización:
PUT /api/fhir/r6-ballot4/<Resource>/{rid} - Versión leída:
GET /api/fhir/r6-ballot4/<Resource>/{rid}/_history/{vid} - Supresión lógica:
DELETE /api/fhir/r6-ballot4/<Resource>/{rid}
Un DELETE estándar es una supresión lógica. POST /api/fhir/r6-ballot4/<Resource>/{rid}/$hardDelete suprime permanentemente un recurso suprimido de forma lógica elegible, mientras que POST /api/fhir/r6-ballot4/<Resource>/$purgeDeleted suprime de forma permanente los recursos suprimidos de forma lógica 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 en el recurso de destino.
- Tratar
_countcomo un tamaño de página máximo solicitado. Una página puede contener menos entradas. Bundle.totales opcional, incluso cuando se solicita un modo_totalsoportado.- Siga la URL en la entrada
Bundle.linkcuya relación seanextliteralmente. No cree ni edite la URL de paginación.
Las URL de búsqueda pueden contener PHI. Consulte Protect Sensitive Search Data.
Parámetros específicos de recursos
| Recurso | Parámetros además de controles comunes |
|---|---|
Device | patient, status, type, manufacturer, model |
DeviceAssociation | date, device, patient, status, subject |
Encounter | class, date, discharge-disposition, identifier, location, patient, status, type |
Location | identifier, status, partof, form, name, address, address-city, address-state, address-postalcode |
Observation | category, code, date, device, encounter, patient, specimen, status |
Patient | birthdate, death-date, family, given, identifier, name |
Practitioner | identifier, name |
PractitionerRole | practitioner, specialty |
Provenance | activity, agent, target, when |
Subscription | owner, topic, url, status |
SubscriptionTopic | url |
El parámetro de referencia practitioner de PractitionerRole anuncia las cadenas identifier y name. Por ejemplo: GET /api/fhir/r6-ballot4/PractitionerRole?practitioner.name=Smith&_count=20.
Ejemplos
GET /api/fhir/r6-ballot4/Location?status=active&form=si&_count=20
GET /api/fhir/r6-ballot4/Observation?patient=Patient/{rid}&code=http%3A%2F%2Floinc.org%7C8867-4
GET /api/fhir/r6-ballot4/Subscription?status=active
Una búsqueda correcta devuelve un paquete de conjunto de búsqueda FHIR. Consulte la página de punto final aplicable y Parámetros de Control y Búsqueda Soportados para obtener más información sobre los parámetros.
Operaciones de estado de suscripción
Utilice GET /api/fhir/r6-ballot4/Subscription/$status para varias suscripciones y GET /api/fhir/r6-ballot4/Subscription/{rid}/$status para una suscripción cuando se publique. Consulte FHIR R6 Subscriptions.