FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.us.ode
Resource TypeOperationDefinition
IdOperationDefinition-ode-append-interim.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/HL7/ode/OperationDefinition-ode-append-interim.html
URLhttp://hl7.org/fhir/us/ode/OperationDefinition/ode-append-interim
Version0.1.0
Statusdraft
Date2026-09-21T18:04:53+00:00
NameODEAppendInterim
TitleAppend interim clinical content to a referral
Realmus
Authorityhl7
DescriptionCreates the supplied clinical resources (Encounter, DiagnosticReport, Observation, ...), attaches them to the referral Task's `output`, and advances `businessStatus` (typically to `interim-results`). Use this when new clinical findings arise mid-referral; use the initial transaction Bundle (POST /) for the initial referral submission only.
Typefalse
Kindoperation

Resources that use this resource

CapabilityStatement
hl7.fhir.us.ode#currentode-referral-recipient-serverODE Referral Recipient / Fulfiller — Server

Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition ode-append-interim

URL: [base]/Task/[id]/$append-interim

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INcontent1..1Bundle

A collection Bundle of the interim clinical resources to attach (ODEEncounter, ODEDiagnosticReport, ODEObservation).

OUTreturn1..1Task

The updated referral Task, with output populated and businessStatus advanced.


Source1

{
  "resourceType": "OperationDefinition",
  "id": "ode-append-interim",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "claims"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 0,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/ode/ImplementationGuide/hl7.fhir.us.ode"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "draft",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/ode/ImplementationGuide/hl7.fhir.us.ode"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/ode/OperationDefinition/ode-append-interim",
  "version": "0.1.0",
  "name": "ODEAppendInterim",
  "title": "Append interim clinical content to a referral",
  "status": "draft",
  "kind": "operation",
  "date": "2026-09-21T18:04:53+00:00",
  "publisher": "HL7 International / Payer/Provider Information Exchange Work Group",
  "contact": [
    {
      "name": "HL7 International / Payer/Provider Information Exchange Work Group",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/claims"
        },
        {
          "system": "email",
          "value": "pie@lists.hl7.org"
        }
      ]
    },
    {
      "name": "Mark Marciante",
      "telecom": [
        {
          "system": "email",
          "value": "mark.marciante@leavittpartners.com",
          "use": "work"
        }
      ]
    }
  ],
  "description": "Creates the supplied clinical resources (Encounter, DiagnosticReport, Observation, ...), attaches them to the referral Task's `output`, and advances `businessStatus` (typically to `interim-results`). Use this when new clinical findings arise mid-referral; use the initial transaction Bundle (POST /) for the initial referral submission only.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US",
          "display": "United States of America"
        }
      ]
    }
  ],
  "code": "append-interim",
  "resource": [
    "Task"
  ],
  "system": false,
  "type": false,
  "instance": true,
  "parameter": [
    {
      "name": "content",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "A collection Bundle of the interim clinical resources to attach (ODEEncounter, ODEDiagnosticReport, ODEObservation).",
      "type": "Bundle"
    },
    {
      "name": "return",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The updated referral Task, with `output` populated and `businessStatus` advanced.",
      "type": "Task"
    }
  ]
}