Package | hl7.fhir.us.smp |
Resource Type | OperationDefinition |
Id | smp-operation-retrieve |
FHIR Version | R4 |
Source | http://hl7.org/fhir/us/smp/https://build.fhir.org/ig/HL7/smp-ig/OperationDefinition-smp-operation-retrieve.html |
URL | http://hl7.org/fhir/us/smp/OperationDefinition/smp-operation-retrieve |
Version | 1.0.0 |
Status | active |
Date | 2025-01-07T00:00:00-05:00 |
Name | SMPOperationRetrieve |
Title | SMP Operation Retrieve |
Realm | us |
Authority | hl7 |
Description | Optional operation to request an individual patient's medication history |
Type | false |
Kind | operation |
CapabilityStatement | |
smp-server | SMP_Server |
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: OperationDefinition smp-operation-retrieve
URL: [base]/$smp-query
Input parameters Profile:SMP Parameters - Query
Output parameters Profile:SMP Parameters - Response
Use | Name | Scope | Cardinality | Type | Binding | Documentation |
IN | patient | 1..1 | Patient (US Core Patient Profile) | The patient whose medication history is desired | ||
IN | list-type | 0..1 | CodeableConcept | Optional parameter to define the type of medication list to be retrieved | ||
OUT | smp-medication-data | 0..1 | Bundle (Standardized Medication Profile - Bundle Medication List) | A Bundle of type 'collection' that contains medication information for the requested patient (if found) | ||
OUT | outcome | 0..1 | OperationOutcome | An OperationOutcome resource containing processing information associated with the operation response, including error, warning and/or informational information |
{ "resourceType": "OperationDefinition", "id": "smp-operation-retrieve", "text": { "status": "generated", "div": "<!-- snip (see above) -->" }, "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg", "valueCode": "phx" }, { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm", "valueInteger": 1, "_valueInteger": { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom", "valueCanonical": "http://hl7.org/fhir/us/smp/ImplementationGuide/hl7.fhir.us.smp" } ] } }, { "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/smp/ImplementationGuide/hl7.fhir.us.smp" } ] } } ], "url": "http://hl7.org/fhir/us/smp/OperationDefinition/smp-operation-retrieve", "version": "1.0.0", "name": "SMPOperationRetrieve", "title": "SMP Operation Retrieve", "status": "active", "kind": "operation", "date": "2025-01-07T00:00:00-05:00", "publisher": "HL7 International / Pharmacy", "contact": [ { "name": "HL7 International / Pharmacy", "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/medication" }, { "system": "email", "value": "pharmacylists@lists.hl7.org" } ] }, { "name": "Andy Stechishin", "telecom": [ { "system": "email", "value": "mailto:andy.stechishin@gmail.com" } ] } ], "description": "Optional operation to request an individual patient's medication history", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "US", "display": "United States of America" } ] } ], "affectsState": false, "code": "smp-query", "system": true, "type": false, "instance": false, "inputProfile": "http://hl7.org/fhir/us/smp/StructureDefinition/smp-parameters-query", "outputProfile": "http://hl7.org/fhir/us/smp/StructureDefinition/smp-parameters-response", "parameter": [ { "name": "patient", "use": "in", "min": 1, "max": "1", "documentation": "The patient whose medication history is desired", "type": "Patient", "targetProfile": [ "http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient" ] }, { "name": "list-type", "use": "in", "min": 0, "max": "1", "documentation": "Optional parameter to define the type of medication list to be retrieved", "type": "CodeableConcept" }, { "name": "smp-medication-data", "use": "out", "min": 0, "max": "1", "documentation": "A Bundle of type 'collection' that contains medication information for the requested patient (if found)", "type": "Bundle", "targetProfile": [ "http://hl7.org/fhir/us/smp/StructureDefinition/smp-bundle" ] }, { "name": "outcome", "use": "out", "min": 0, "max": "1", "documentation": "An OperationOutcome resource containing processing information associated with the operation response, including error, warning and/or informational information", "type": "OperationOutcome" } ] }