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

FHIR IG analytics

Packagehl7.fhir.us.immds
Resource TypeOperationDefinition
IdOperationDefinition-ImmDSForecastOperation.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/HL7/ImmunizationFHIRDS/OperationDefinition-ImmDSForecastOperation.html
URLhttp://hl7.org/fhir/us/immds/OperationDefinition/ImmDSForecastOperation
Version2.0.0
Statusactive
Date2025-11-20T20:43:18+00:00
NameImmDSForecast
TitleImmunization Decision Support Forecast
Realmus
Authorityhl7
DescriptionThe Immunization Decision Support Forecast Request operation to provide standardized request and response interfaces to Immunization Forecasters.
Typefalse
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

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

Generated Narrative: OperationDefinition ImmDSForecastOperation

URL: [base]/$immds-forecast

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INassessmentDate1..1date

The date on which to assess the forecast.

INpatient1..1Patient

Patient information.

INimmunization0..*Immunization

Patient immunization history.

OUTevaluation0..*ImmunizationEvaluation

The evaluation against a schedule.

OUTrecommendation1..1ImmunizationRecommendation

The decision support engine produced forecast.


Source1

{
  "resourceType": "OperationDefinition",
  "id": "ImmDSForecastOperation",
  "text": {
    "status": "generated",
    "div": "<!-- snip (see above) -->"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "pher"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 3,
      "_valueInteger": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/immds/ImplementationGuide/hl7.fhir.us.immds"
          }
        ]
      }
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use",
      "_valueCode": {
        "extension": [
          {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical": "http://hl7.org/fhir/us/immds/ImplementationGuide/hl7.fhir.us.immds"
          }
        ]
      }
    }
  ],
  "url": "http://hl7.org/fhir/us/immds/OperationDefinition/ImmDSForecastOperation",
  "version": "2.0.0",
  "name": "ImmDSForecast",
  "title": "Immunization Decision Support Forecast",
  "status": "active",
  "kind": "operation",
  "date": "2025-11-20T20:43:18+00:00",
  "publisher": "HL7 International / Public Health",
  "contact": [
    {
      "name": "HL7 International / Public Health",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/pher"
        }
      ]
    },
    {
      "name": "Nathan Bunker",
      "telecom": [
        {
          "system": "email",
          "value": "mailto:nbunker@immregistry.org"
        }
      ]
    }
  ],
  "description": "The Immunization Decision Support Forecast Request operation to provide standardized request and response interfaces to Immunization Forecasters.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "US"
        }
      ]
    }
  ],
  "code": "immds-forecast",
  "system": true,
  "type": false,
  "instance": false,
  "parameter": [
    {
      "name": "assessmentDate",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The date on which to assess the forecast.",
      "type": "date"
    },
    {
      "name": "patient",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "Patient information.",
      "type": "Patient"
    },
    {
      "name": "immunization",
      "use": "in",
      "min": 0,
      "max": "*",
      "documentation": "Patient immunization history.",
      "type": "Immunization"
    },
    {
      "name": "evaluation",
      "use": "out",
      "min": 0,
      "max": "*",
      "documentation": "The evaluation against a schedule.",
      "type": "ImmunizationEvaluation"
    },
    {
      "name": "recommendation",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "The decision support engine produced forecast.",
      "type": "ImmunizationRecommendation"
    }
  ]
}