Skip to main content

Clinical Act Extract

Category: Healthcare Standards
Node id: clinical-act-extract
Maturity: production
Risk tier: B

Standards: FHIR R4

Project FHIR Encounter, Procedure, Observation, DiagnosticReport, ImagingStudy and ServiceRequest resources onto the clinical act records that act reconciliation compares: patient, act kind, code, start and end, source identifier, performer and location. Pure transform, no I/O.

What it does​

  • Projects six FHIR resource types onto one act shape
  • Normalises coded concepts to system|code
  • Carries source system and source reference as provenance
  • Reports every resource it could not place, with a reason

Use cases​

  • Preparing episodes, consultations, tests and procedures for reconciliation
  • Building one timeline per patient from several feeder systems
  • Detecting which resources a feed cannot contribute to a timeline

Runtime​

  • Performance tier: fast

Input ports​

NameTypeRequiredDescription
resourcesfhir-bundleYesA FHIR Bundle, an array of resources, or a single resource.
patient_global_idtextNoEMPI global id of the already-resolved patient these resources belong to. Overrides the config value.

Output ports​

NameTypeRequiredDescription
recordsjsonNoClinical act records, ready to feed the EMPI node in ingest mode.
countnumberNoHow many act records were produced.
skippedjsonNoResources that produced no act, each with the reason. Never silently dropped: a missing procedure is a gap in the timeline.

Settings​

Basic​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Patient Global IDpatient_global_idstringNoEMPI global id of the resolved patient, when it is fixed for the run rather than wired from an upstream node.
Source Systemsource_systemstringNounknownName of the feeder system these resources came from. Recorded as provenance on every act, and shown to a reviewer deciding whether two acts are the same.

Advanced​

SettingNameTypeRequiredDefaultAllowed valuesDescription
Act Kindsact_typesstringNoComma-separated act kinds to keep (encounter, procedure, observation, diagnostic_report, imaging_study, service_request). Empty keeps all of them.
Require Patientrequire_patientbooleanNotrueSkip acts with no resolved patient instead of emitting them. On by default: an act with no patient can never be reconciled, because every blocking round is scoped by patient.

Errors​

CodeDescription
ACT_INPUTThe resources input is missing or is not a Bundle, array or resource

Runtime notes​

  • Pure transform: no network calls, no service dependency.
  • Feeds arriving as HL7 v2 or as documents are converted to FHIR upstream (hl7-to-fhir, document-to-fhir) before this node.
  • patient_global_id must be the id produced by identity resolution, not a source-system MRN: reconciliation compares acts within one resolved patient.
  • An act kind is a reconciliation boundary — an Encounter and the Procedure inside it stay separate timeline entries.

See Build any workflow for how to put nodes together and Ports, types and data flow for how port types connect.

Something unclear? Send documentation feedback by email.