haau3 FHIR Implementation Guide (HFIG)
1.0.0 - ci-build
haau3 FHIR Implementation Guide (HFIG)
1.0.0 - ci-build
haau3 FHIR Implementation Guide (HFIG) - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2026-10-30 |
<OperationDefinition xmlns="http://hl7.org/fhir">
<id value="structure-dosage"/>
<text>
<status value="generated"/>
<div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: OperationDefinition structure-dosage</b></p><a name="structure-dosage"> </a><a name="hcstructure-dosage"> </a><p>URL: [base]/$structure-dosage</p><h3>Parameters</h3><table class="grid"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>text</td><td/><td>1..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#string">string</a></td><td/><td><div><p>The prescription's directions as written, at most 1,000 characters. They come back verbatim in Dosage.text.</p>
</div></td></tr><tr><td>IN</td><td>medication</td><td/><td>0..1</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#CodeableConcept">CodeableConcept</a></td><td/><td><div><p>The medication the directions are for, as its codings: RxNorm, or an NDC. With an RxNorm code, the product's dose form checks the dose's unit and the route, and supplies either when the directions name none. An NDC, or a code system that is not read, is flagged and nothing about the product is used.</p>
</div></td></tr><tr><td>OUT</td><td>dosage</td><td/><td>1..*</td><td><a href="http://hl7.org/fhir/R4/datatypes.html#Dosage">Dosage</a></td><td/><td><div><p>The structured directions: a Dosage conforming to haau3 Structured Dosage, with its review flags and the engine and vocabulary versions on it. One today; directions that give several doses or schedules at once come back as text with a flag.</p>
</div></td></tr></table><div><p>POST a Parameters resource with one <code>text</code> part and, optionally, one <code>medication</code> part. Send the directions and the medication's codings only, never a patient. A request is refused, with an OperationOutcome that names the part at fault, for any other parameter, a missing or repeated <code>text</code>, directions over 1,000 characters, a repeated <code>medication</code>, a <code>medication</code> that is not a CodeableConcept or carries over 20 codings, or a body over 64 KiB. When the medication carries an RxNorm code, its dose form checks the dose's unit and the route, and supplies either when the directions name none, each flagged; when RxNorm cannot be read, the request is turned down as retryable rather than answered without it. The answer is a Parameters resource with one <code>dosage</code> part. The operation may be sent inside a batch, one request per entry.</p>
</div></div>
</text>
<url value="https://haau3.com/fhir/OperationDefinition/structure-dosage"/>
<version value="1.0.0"/>
<name value="StructureDosage"/>
<title value="Structure dosage"/>
<status value="active"/>
<kind value="operation"/>
<date value="2026-10-30"/>
<publisher value="haau3"/>
<contact>
<name value="haau3"/>
<telecom>
<system value="url"/>
<value value="https://haau3.com"/>
</telecom>
<telecom>
<system value="email"/>
<value value="hello@haau3.com"/>
</telecom>
</contact>
<description
value="Structures one prescription's free-text directions, such as "Take 1 tablet by mouth twice daily", as a [haau3 Structured Dosage](StructureDefinition-haau3-structured-dosage.html): the dose and its unit, the route, the method, the timing and whether it is taken as needed, each coded where the words support it, and the directions kept verbatim in Dosage.text. Nothing is invented: an element the directions do not support is absent, and anything a person should check is a [review flag](CodeSystem-structured-sig-review-flag.html) on the Dosage. Software computes the answer; no person reviews it."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="US"/>
<display value="United States of America"/>
</coding>
</jurisdiction>
<affectsState value="false"/>
<code value="structure-dosage"/>
<comment
value="POST a Parameters resource with one `text` part and, optionally, one `medication` part. Send the directions and the medication's codings only, never a patient. A request is refused, with an OperationOutcome that names the part at fault, for any other parameter, a missing or repeated `text`, directions over 1,000 characters, a repeated `medication`, a `medication` that is not a CodeableConcept or carries over 20 codings, or a body over 64 KiB. When the medication carries an RxNorm code, its dose form checks the dose's unit and the route, and supplies either when the directions name none, each flagged; when RxNorm cannot be read, the request is turned down as retryable rather than answered without it. The answer is a Parameters resource with one `dosage` part. The operation may be sent inside a batch, one request per entry."/>
<system value="true"/>
<type value="false"/>
<instance value="false"/>
<parameter>
<name value="text"/>
<use value="in"/>
<min value="1"/>
<max value="1"/>
<documentation
value="The prescription's directions as written, at most 1,000 characters. They come back verbatim in Dosage.text."/>
<type value="string"/>
</parameter>
<parameter>
<name value="medication"/>
<use value="in"/>
<min value="0"/>
<max value="1"/>
<documentation
value="The medication the directions are for, as its codings: RxNorm, or an NDC. With an RxNorm code, the product's dose form checks the dose's unit and the route, and supplies either when the directions name none. An NDC, or a code system that is not read, is flagged and nothing about the product is used."/>
<type value="CodeableConcept"/>
</parameter>
<parameter>
<extension
url="http://hl7.org/fhir/StructureDefinition/operationdefinition-profile">
<valueUri
value="https://haau3.com/fhir/StructureDefinition/haau3-structured-dosage"/>
</extension>
<name value="dosage"/>
<use value="out"/>
<min value="1"/>
<max value="*"/>
<documentation
value="The structured directions: a Dosage conforming to haau3 Structured Dosage, with its review flags and the engine and vocabulary versions on it. One today; directions that give several doses or schedules at once come back as text with a flag."/>
<type value="Dosage"/>
</parameter>
</OperationDefinition>