physical-record-scans — BestDoctorsRD API

GET/v1/physical-record-scans

List Scans

Parámetros

Nombre	En	Tipo	Obl.
`patientId`	query	string o nulo	No
`folioType`	query	string o nulo	No
`legacyRecordNumber`	query	string o nulo	No
`admissionId`	query	string o nulo	No
`encounterId`	query	string o nulo	No
`originalDateFrom`	query	string (date) o nulo	No
`originalDateTo`	query	string (date) o nulo	No
`includeUndated`	query	boolean	No
`includeInvalidated`	query	boolean	No
`page`	query	integer	No
`pageSize`	query	integer	No
`tenant_id`	query	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	ScanPage
422	Error de validación	HTTPValidationError

POST/v1/physical-record-scans

Upload Scan

Multipart: patientId, metadata (JSON), order (zero-based JSON permutation), files.

Parámetros

Nombre	En	Tipo	Obl.
`tenant_id`	query	string o nulo	No
`Idempotency-Key`	header	string	Sí

Cuerpo obligatorio `object`

Campo	Tipo	Obl.
`patientId`	string	Sí
`metadata`JSON con folioType, title y metadatos opcionales de ScanMetadata.	string	Sí
`order`JSON: permutación de índices de files desde 0.	string	Sí
`files`	lista de string (binary)	Sí

Respuestas

Código	Descripción	Devuelve
201	Respuesta correcta	ScanOut
422	Error de validación	HTTPValidationError

curl

curl -X POST "https://api.bestdoctorsrd.com/v1/physical-record-scans" \
  -H "Idempotency-Key: {Idempotency-Key}" \
  -H "Content-Type: application/json" \
  -d '{ "patientId": …, "metadata": …, "order": …, "files": … }'

GET/v1/physical-record-scans/catalog

Catalog

Parámetros

Nombre	En	Tipo	Obl.
`tenant_id`	query	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	ScanCatalog
422	Error de validación	HTTPValidationError

GET/v1/physical-record-scans/{scan_id}

Detail

Parámetros

Nombre	En	Tipo	Obl.
`scan_id`	path	string	Sí
`includeInvalidated`	query	boolean	No
`tenant_id`	query	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	ScanOut
422	Error de validación	HTTPValidationError

PATCH/v1/physical-record-scans/{scan_id}

Correct

Parámetros

Nombre	En	Tipo	Obl.
`scan_id`	path	string	Sí
`tenant_id`	query	string o nulo	No

Cuerpo obligatorio `ScanPatch`

Campo	Tipo	Obl.
`version`	integer	Sí
`reason`	string	Sí
`folioType`	string o nulo	No
`title`	string o nulo	No
`legacyRecordNumber`	string o nulo	No
`originalDocumentDate`	string (date) o nulo	No
`originLocation`	string o nulo	No
`notes`	string o nulo	No
`admissionId`	string o nulo	No
`encounterId`	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	ScanOut
422	Error de validación	HTTPValidationError

GET/v1/physical-record-scans/{scan_id}/audit

History

Parámetros

Nombre	En	Tipo	Obl.
`scan_id`	path	string	Sí
`page`	query	integer	No
`pageSize`	query	integer	No
`tenant_id`	query	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	ScanAuditPage
422	Error de validación	HTTPValidationError

GET/v1/physical-record-scans/{scan_id}/files/{file_id}

Read Original

Parámetros

Nombre	En	Tipo	Obl.
`scan_id`	path	string	Sí
`file_id`	path	string	Sí
`openingId`	query	string (uuid)	Sí
`disposition`	query	"preview" \| "download"	No
`tenant_id`	query	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	objeto
422	Error de validación	HTTPValidationError

HEAD/v1/physical-record-scans/{scan_id}/files/{file_id}

Read Original

Parámetros

Nombre	En	Tipo	Obl.
`scan_id`	path	string	Sí
`file_id`	path	string	Sí
`openingId`	query	string (uuid)	Sí
`disposition`	query	"preview" \| "download"	No
`tenant_id`	query	string o nulo	No

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	objeto
422	Error de validación	HTTPValidationError

POST/v1/physical-record-scans/{scan_id}/invalidate

Invalidate

Parámetros

Nombre	En	Tipo	Obl.
`scan_id`	path	string	Sí
`tenant_id`	query	string o nulo	No

Cuerpo obligatorio `InvalidateScan`

Campo	Tipo	Obl.
`version`	integer	Sí
`reason`	string	Sí

Respuestas

Código	Descripción	Devuelve
200	Respuesta correcta	InvalidationOut
422	Error de validación	HTTPValidationError

List Scans

Parámetros

Respuestas

Upload Scan

Parámetros

Cuerpo obligatorio object

Respuestas

Catalog

Parámetros

Respuestas

Detail

Parámetros

Respuestas

Correct

Parámetros

Cuerpo obligatorio ScanPatch

Respuestas

History

Parámetros

Respuestas

Read Original

Parámetros

Respuestas

Read Original

Parámetros

Respuestas

Invalidate

Parámetros

Cuerpo obligatorio InvalidateScan

Respuestas

Cuerpo obligatorio `object`

Cuerpo obligatorio `ScanPatch`

Cuerpo obligatorio `InvalidateScan`