Release 4 Snapshot 3: Connectathon 32 Base

This page is part of the Snapshot #3 for FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). The current version which supercedes this version is 5.0.0 R5 , released to support Connectathon 32 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Operation-resource-validate

Example MedicationDispense/meddisp0310 (Turtle)

IN resource
FHIR Infrastructure Pharmacy Work Group Maturity Level : N/A Standards Status : Informative Compartments : Not linked to any defined compartments This is the narrative for the resource. See also the XML Encounter , JSON or Turtle format. Validate a resource OPERATION: Validate a resource The official URL for this operation definition is: http://hl7.org/fhir/OperationDefinition/Resource-validate The validate operation checks whether the attached content would be acceptable either generally, as a create, an update or as a delete to an existing resource. The action the server takes depends on the mode parameter: [mode not provided]: The server checks the content of the resource against any schema, constraint rules, and other general terminology rules create: The server checks the content, and then checks that the content would be acceptable as a create (e.g. that the content would not violate any uniqueness constraints) update: The server checks the content, and then checks that it would accept it as an update against the nominated specific resource (e.g. that there are no changes to immutable fields the server does not allow to change, and checking version integrity if appropriate) delete: The server ignores the content, and checks that the nominated resource is allowed to be deleted (e.g. checking referential integrity rules) Modes update and delete can only be used when the operation is invoked at the resource instance level. The return from this operation is an OperationOutcome Note that this operation is not the only way to validate resources - see Validating Resources Patient , Practitioner for further information. URL: [base]/Resource/$validate URL: [base]/Resource/[id]/$validate Parameters Use Name Cardinality Type Binding Documentation
0..1
  • Resource Narrative Must be present unless the mode is "delete" IN mode 0..1
  • code XML
  • http://hl7.org/fhir/ValueSet/resource-validation-mode|4.0.1 JSON (Required) Default is 'no action'; (e.g. general validation) IN profile 0..1
  • uri TTL

If this is nominated, then the resource is validated against this specific profile. If a profile is nominated, and the server cannot validate against the nominated profile, it SHALL return an error OUT return 1..1 OperationOutcome Raw Turtle If the operation outcome does not list any errors, and a mode was specified, then this is an indication that the operation would be expected to succeed (excepting for transactional integrity issues, see below) This operation may be used during design and development to validate application design. It can (+ also be used at run-time. One possible use might be that a client asks the server whether a proposed update is valid as the user is editing a dialog and displays an updated error to the user. The operation can be used as part of a light-weight two phase commit protocol but there is no expectation that the server will hold the content of the resource after this operation is used, or that the server guarantees to successfully perform an actual create, update or delete after the validation operation completes. This operation returns a 200 OK whether or not the resource is valid. A 4xx or 5xx error means that the validation itself could not be performed, and it is unknown whether the resource is valid or not. see Turtle/RDF Format Specification )

Note: the correct behaviour of validation with regard to language (especially Dispense for Coding.display) is currently undefined, and further development Percocet (NDC Code) - in-progress with additionalInstructions, and testing may lead to specific requirements or recommendations in subsequent releases Future versions of this specifcation may add additional validation parameters. A candidate list is maintained as needed dosage with the FHIR Validator Documentation condition 

@prefix fhir: <http://hl7.org/fhir/> .
@prefix owl: <http://www.w3.org/2002/07/owl#> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .
@prefix sct: <http://snomed.info/id/> .
@prefix xsd: <http://www.w3.org/2001/XMLSchema#> .

# - resource -------------------------------------------------------------------

[a fhir:MedicationDispense;
  fhir:nodeRole fhir:treeRoot;
  fhir:Resource.id [ fhir:value "meddisp0310"]; # 
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ];
     fhir:Narrative.div "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative: MedicationDispense</b><a name=\"meddisp0310\"> </a></p><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\">Resource MedicationDispense &quot;meddisp0310&quot; </p></div><p><b>status</b>: in-progress</p><h3>Medications</h3><table class=\"grid\"><tr><td>-</td><td><b>Reference</b></td></tr><tr><td>*</td><td><span title=\"  Linked to a RESOURCE Medication  \"><a name=\"med0308\"> </a></span><blockquote><p/><p><a name=\"med0308\"> </a></p><p><b>code</b>: Percocet tablet <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-ndc.html\">National drug codes</a>#63481-623-70)</span></p></blockquote></td></tr></table><p><b>subject</b>: <a href=\"patient-example-a.html\">Patient/pat1: Donald Duck </a> &quot;Donald DUCK&quot;</p><h3>Performers</h3><table class=\"grid\"><tr><td>-</td><td><b>Actor</b></td></tr><tr><td>*</td><td><a href=\"practitioner-example-f006-rvdb.html\">Practitioner/f006</a> &quot;Rob VAN DEN BERK&quot;</td></tr></table><p><b>authorizingPrescription</b>: <a href=\"medicationrequest0307.html\">MedicationRequest/medrx0307</a></p><p><b>type</b>: Emergency Supply <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"http://terminology.hl7.org/4.0.0/CodeSystem-v3-ActCode.html\">ActCode</a>#EM)</span></p><p><b>quantity</b>: 30 TAB<span style=\"background: LightGoldenRodYellow\"> (Details: http://terminology.hl7.org/CodeSystem/v3-orderableDrugForm code TAB = 'Tablet')</span></p><p><b>daysSupply</b>: 30 Day<span style=\"background: LightGoldenRodYellow\"> (Details: UCUM code d = 'd')</span></p><p><b>whenPrepared</b>: 2015-01-15T10:20:00Z</p><blockquote><p><b>dosageInstruction</b></p><p><b>sequence</b>: 1</p><p><b>text</b>: 1 tablet every four hours as needed for pain</p><p><b>additionalInstruction</b>: Warning. May cause drowsiness. If affected do not drive or operate machinery. Avoid alcoholic drink (qualifier value) <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#418914006)</span></p><p><b>timing</b>: Once per 4 hours</p><p><b>asNeededFor</b>: Fibromyalgia (disorder) <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#203082005)</span></p><p><b>route</b>: Oral Route <span style=\"background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki\"> (<a href=\"https://browser.ihtsdotools.org/\">SNOMED CT</a>#26643006)</span></p></blockquote></div>"
  ]; # 
  fhir:DomainResource.contained [
     a fhir:Medication;
     fhir:index 0;
     fhir:Resource.id [ fhir:value "med0308" ];
     fhir:Medication.code [
       fhir:CodeableConcept.coding [
         fhir:index 0;
         fhir:Coding.system [ fhir:value "http://hl7.org/fhir/sid/ndc" ];
         fhir:Coding.code [ fhir:value "63481-623-70" ];
         fhir:Coding.display [ fhir:value "Percocet tablet" ]
       ]
     ]
  ]; # 
  fhir:MedicationDispense.status [ fhir:value "in-progress"]; # 
  fhir:MedicationDispense.medication [
     fhir:CodeableReference.reference [
       fhir:Reference.reference [ fhir:value "#med0308" ];
       fhir:Reference.display [ fhir:value "Percocet" ]
     ] #    Linked to a RESOURCE Medication   
  ]; # 
  fhir:MedicationDispense.subject [
     fhir:Reference.reference [ fhir:value "Patient/pat1" ];
     fhir:Reference.display [ fhir:value "Donald Duck " ]
  ]; # 
  fhir:MedicationDispense.performer [
     fhir:index 0;
     fhir:MedicationDispense.performer.actor [
       fhir:Reference.reference [ fhir:value "Practitioner/f006" ]
     ]
  ]; # 
  fhir:MedicationDispense.authorizingPrescription [
     fhir:index 0;
     fhir:Reference.reference [ fhir:value "MedicationRequest/medrx0307" ]
  ]; # 
  fhir:MedicationDispense.type [
     fhir:CodeableConcept.coding [
       fhir:index 0;
       fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/v3-ActCode" ];
       fhir:Coding.code [ fhir:value "EM" ];
       fhir:Coding.display [ fhir:value "Emergency Supply" ]
     ]
  ]; # 
  fhir:MedicationDispense.quantity [
     fhir:Quantity.value [ fhir:value "30"^^xsd:decimal ];
     fhir:Quantity.unit [ fhir:value "TAB" ];
     fhir:Quantity.system [ fhir:value "http://terminology.hl7.org/CodeSystem/v3-orderableDrugForm" ];
     fhir:Quantity.code [ fhir:value "TAB" ]
  ]; # 
  fhir:MedicationDispense.daysSupply [
     fhir:Quantity.value [ fhir:value "30"^^xsd:decimal ];
     fhir:Quantity.unit [ fhir:value "Day" ];
     fhir:Quantity.system [ fhir:value "http://unitsofmeasure.org" ];
     fhir:Quantity.code [ fhir:value "d" ]
  ]; # 
  fhir:MedicationDispense.whenPrepared [ fhir:value "2015-01-15T10:20:00Z"^^xsd:dateTime]; # 
  fhir:MedicationDispense.dosageInstruction [
     fhir:index 0;
     fhir:Dosage.sequence [ fhir:value "1"^^xsd:integer ];
     fhir:Dosage.text [ fhir:value "1 tablet every four hours as needed for pain" ];
     fhir:Dosage.additionalInstruction [
       fhir:index 0;
       fhir:CodeableConcept.coding [
         fhir:index 0;
         a sct:418914006;
         fhir:Coding.system [ fhir:value "http://snomed.info/sct" ];
         fhir:Coding.code [ fhir:value "418914006" ];
         fhir:Coding.display [ fhir:value "Warning. May cause drowsiness. If affected do not drive or operate machinery. Avoid alcoholic drink (qualifier value)" ]
       ]
     ];
     fhir:Dosage.timing [
       fhir:Timing.repeat [
         fhir:Timing.repeat.frequency [ fhir:value "1"^^xsd:positiveInteger ];
         fhir:Timing.repeat.period [ fhir:value "4"^^xsd:decimal ];
         fhir:Timing.repeat.periodUnit [ fhir:value "h" ]
       ]
     ];
     fhir:Dosage.asNeededFor [
       fhir:index 0;
       fhir:CodeableConcept.coding [
         fhir:index 0;
         a sct:203082005;
         fhir:Coding.system [ fhir:value "http://snomed.info/sct" ];
         fhir:Coding.code [ fhir:value "203082005" ];
         fhir:Coding.display [ fhir:value "Fibromyalgia (disorder)" ]
       ]
     ];
     fhir:Dosage.route [
       fhir:CodeableConcept.coding [
         fhir:index 0;
         a sct:26643006;
         fhir:Coding.system [ fhir:value "http://snomed.info/sct" ];
         fhir:Coding.code [ fhir:value "26643006" ];
         fhir:Coding.display [ fhir:value "Oral Route" ]
       ]
     ];
     fhir:Dosage.doseAndRate [
       fhir:index 0;
       fhir:Dosage.doseAndRate.type [
         fhir:CodeableConcept.coding [
           fhir:index 0;
           fhir:Coding.system [ fhir:value "http://terminology.hl7.org/CodeSystem/dose-rate-type" ];
           fhir:Coding.code [ fhir:value "ordered" ];
           fhir:Coding.display [ fhir:value "Ordered" ]
         ]
       ];
       fhir:Dosage.doseAndRate.doseQuantity [
         fhir:Quantity.value [ fhir:value "1"^^xsd:decimal ];
         fhir:Quantity.unit [ fhir:value "TAB" ];
         fhir:Quantity.system [ fhir:value "http://terminology.hl7.org/CodeSystem/v3-orderableDrugForm" ];
         fhir:Quantity.code [ fhir:value "TAB" ]
       ]
     ]
  ]] . # 

# - ontology header ------------------------------------------------------------

[a owl:Ontology;
  owl:imports fhir:fhir.ttl] .

# -------------------------------------------------------------------------------------
   

Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.