Package | hl7.fhir.uv.immds |
Type | OperationDefinition |
Id | immds-forecast-operation |
FHIR Version | R4 |
Source | http://hl7.org/fhir/uv/immds/http://hl7.org/fhir/uv/immds/2019Sep/OperationDefinition-immds-forecast-operation.html |
URL | http://hl7.org/fhir/uv/immds/OperationDefinition/immds-forecast-operation |
Version | 0.2.0 |
Status | draft |
Date | 2019-06-26T14:47:00-04:00 |
Name | ImmDSForecast |
Realm | uv |
Authority | hl7 |
Description | This is an Immunization Decision Support Forecast Request operation. It provides standardized request and response interfaces to Immunization Forecasters. |
Type | false |
Kind | operation |
CapabilityStatement | |
client | Client |
server | Server |
No resources found
Note: links and images are rebased to the (stated) source
OPERATION: ImmunizationDS Forecast
This is an Immunization Decision Support Forecast Request operation. It provides standardized request and response interfaces to Immunization Forecasters.
URL: [base]/$immds-forecast
Parameters
Use | Name | Cardinality | Type | Binding | Documentation |
IN | assessmentDate | 1..1 | date |
The date on which to assess the forecast |
|
IN | patient | 1..1 | Patient |
Patient information |
|
IN | immunization | 0..* | Immunization |
Patient immunization history |
|
OUT | evaluation | 0..* | ImmunizationEvaluation |
The evaluation against a schedule |
|
OUT | recommendation | 1..1 | ImmunizationRecommendation |
The immunization engine produced forecast |
{ "resourceType": "OperationDefinition", "id": "immds-forecast-operation", "text": { "status": "generated", "div": "<!-- snip (see above) -->" }, "url": "http://hl7.org/fhir/uv/immds/OperationDefinition/immds-forecast-operation", "version": "0.2.0", "name": "ImmDSForecast", "status": "draft", "kind": "operation", "date": "2019-06-26T14:47:00-04:00", "publisher": "HL7 International - Medications / Immunizations", "description": "This is an Immunization Decision Support Forecast Request operation. It provides standardized request and response interfaces to Immunization Forecasters.", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "US", "display": "United States of America" } ] } ], "affectsState": false, "code": "immds-forecast", "comment": "Pilot implemented in AEGIS WildFHIR FHIR test client and server - http://wildfhir.aegis.net/fhir4-0-0-gui", "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 immunization engine produced forecast", "type": "ImmunizationRecommendation" } ] }