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-valueset-validate-code

Example PackagedProductDefinition/example (XML)

Vocabulary Biomedical Research and Regulation 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 , JSON or Turtle format. Value Set based Validation OPERATION: Value Set based Validation The official URL for this operation definition is: http://hl7.org/fhir/OperationDefinition/ValueSet-validate-code Validate that a coded value is in the set of codes allowed by a value set. If the operation is not called at the instance level, one of the in parameters url, context or valueSet must be provided. One (and only one) of the in parameters code, coding, or codeableConcept must be provided. The operation returns a result (true / false), an error message, and the recommended display for the code URL: [base]/ValueSet/$validate-code URL: [base]/ValueSet/[id]/$validate-code Parameters Use Name Cardinality Type Binding Documentation IN url 0..1
  • uri Narrative Value set Canonical URL. The server must know the value set (e.g. it is defined explicitly in the server's value sets, or it is defined implicitly by some code system known to the server IN context 0..1
  • uri XML The context of the value set, so that the server can resolve this to a value set to validate against. The recommended format for this URI is [Structure Definition URL]#[name or path into structure definition] e.g. http://hl7.org/fhir/StructureDefinition/observation-hspc-height-hspcheight#Observation.interpretation. Other forms may be used but are not defined. This form is only usable if the terminology server also has access to the conformance registry that the server is using, but can be used to delegate the mapping from an application context to a binding at run-time IN valueSet 0..1
  • ValueSet JSON The value set is provided directly as part of the request. Servers may choose not to accept value sets in this fashion. This parameter is used when the client wants the server to expand a value set that is not stored on the server IN valueSetVersion 0..1
  • string TTL

The identifier that is used to identify a specific version of the value set to be used when validating the code. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. IN code 0..1 code Raw XML The code that is to be validated. If a code is provided, a system or a context must be provided (if a context is provided, then the server SHALL ensure that the code is not ambiguous without a system) IN system 0..1 uri ( canonical form The system for the code that is to be validated IN systemVersion 0..1 string + also see XML Format Specification The version of the system, if one was provided in the source data )

IN display 0..1 string

The display associated with the code, if provided. If a display is provided a code must be provided. If no display is provided, the server cannot validate the display value, but may choose to return a recommended display name using the display parameter in the outcome. Whether displays are case sensitive is code system dependent IN coding 0..1 Coding Jump past Narrative A coding to validate

IN codeableConcept 0..1 CodeableConcept

A full codeableConcept to validate. The server returns true if one of the coding values is in the value set, and may also validate that the codings are not in conflict General example, carton with each other if more than one is present IN date 0..1 dateTime The date for which the validation should be checked. Normally, this is the current conditions (which is the default values) but under some circumstances, systems need to validate that a correct code was used at some point in the past. A typical example of this would be where code selection is constrained to the set of codes that were available when the patient was treated, not when the record is being edited. Note that which date is appropriate is a matter for implementation policy. IN abstract 0..1 boolean If this parameter has a value of true, the client is stating that the validation is being performed in a context where a concept designated as 'abstract' is appropriate/allowed to be used, and the server should regard abstract codes as valid. If this parameter is false, abstract codes are not considered to be valid. Note that. 'abstract' is a property defined by many HL7 code systems that indicates that the concept is a logical grouping concept that is not intended to be used asa 'concrete' concept to in an actual patient/care/process record. This language is borrowed from Object Orienated theory where 'asbtract' objects are never instantiated. However in the general record blister pack and terminology eco-system, there are many contexts where it is appropraite to use these codes e.g. as decision making criterion, or when editing value sets themselves. This parameter allows a client to indicate to the server that it is working in such a context. IN displayLanguage 0..1 code Specifies the language to be used for description when validating the display property OUT result 1..1 boolean True if the concept details supplied are valid OUT message 0..1 string Error details, if result = false. If this is provided when result tablets inside (id = true, the message carries hints and warnings "example")

OUT display 0..1 
<?xml version="1.0" encoding="UTF-8"?>

<PackagedProductDefinition xmlns="http://hl7.org/fhir">
  <id value="example"/> 
  <text> <status value="generated"/> <div xmlns="http://www.w3.org/1999/xhtml"><p> <b> Generated Narrative: PackagedProductDefinition</b> <a name="example"> </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 PackagedProductDefinition &quot;example&quot; </p> </div> <p> <b> identifier</b> : id: {PCID}</p> <p> <b> description</b> : ALU-PVC/PVDC BLISTERS. CARTONS OF 10 FILM-COATED TABLETS.</p> <blockquote> <p> <b> packaging</b> </p> <p> <b> type</b> : Carton <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (packageitemcontainertype#Carton)</span> </p> <p> <b> quantity</b> : <span title="  top level, so this can only ever be 1, but it is optional  ">1</span> </p> <p> <b> material</b> : Paperboard <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (packageItemContainerMaterial#Paperboard)</span> </p> <p> <b> manufacturer</b> : <a href="broken-link.html">Organization/example</a> </p> <blockquote> <p> <b> property</b> </p> <p> <b> type</b> : height <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> ([not stated]#height)</span> </p> <p> <b> value</b> : 50 mm<span style="background: LightGoldenRodYellow"> (Details: UCUM code mm = 'mm')</span> </p> </blockquote> <blockquote> <p> <b> property</b> </p> <p> <b> type</b> : width <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> ([not stated]#width)</span> </p> <p> <b> value</b> : 45 mm<span style="background: LightGoldenRodYellow"> (Details: UCUM code mm = 'mm')</span> </p> </blockquote> <blockquote> <p> <b> property</b> </p> <p> <b> type</b> : depth <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> ([not stated]#depth)</span> </p> <p> <b> value</b> : 23.5 mm<span style="background: LightGoldenRodYellow"> (Details: UCUM code mm = 'mm')</span> </p> </blockquote> <blockquote> <p> <b> packaging</b> </p> <p> <b> type</b> : Blister <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (packageitemcontainertype#Blister)</span> </p> <p> <b> quantity</b> : 1</p> <p> <b> material</b> : PVC <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (packageItemContainerMaterial#PVC)</span> , PVDC <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (packageItemContainerMaterial#PVDC)</span> , alu <span style="background: LightGoldenRodYellow; margin: 4px; border: 1px solid khaki"> (packageItemContainerMaterial#alu)</span> </p> <p> <b> manufacturer</b> : <a href="broken-link.html">Organization/example</a> </p> </blockquote> </blockquote> </div> </text> <identifier> 
    <system value="http://ema.europa.eu/example/pcid"/> 
    <value value="{PCID}"/> 
  </identifier> 
  <description value="ALU-PVC/PVDC BLISTERS. CARTONS OF 10 FILM-COATED TABLETS."/> 
      <!--    outer packaging    -->
  <packaging> 
    <type> 
      <coding> 
        <system value="http://ema.europa.eu/example/packageitemcontainertype"/> 
        <code value="Carton"/> 
      </coding> 
    </type> 
        <!--    top level, so this can only ever be 1, but it is optional    -->
    <quantity value="1"/> 
    <material> 
      <coding> 
        <system value="http://ema.europa.eu/example/packageItemContainerMaterial"/> 
        <code value="Paperboard"/> 
      </coding> 
    </material> 
    <manufacturer> 
      <reference value="Organization/example"/> 
    </manufacturer> 
    <property> 
      <type> 
        <coding> 
          <code value="height"/> 
        </coding> 
      </type> 
      <valueQuantity> 
        <value value="50"/> 
        <unit value="mm"/> 
        <system value="http://unitsofmeasure.org"/>  
        <code value="mm"/> 
      </valueQuantity> 
    </property> 
    <property> 
      <type> 
        <coding> 
          <code value="width"/> 
        </coding> 
      </type> 
      <valueQuantity> 
        <value value="45"/> 
        <unit value="mm"/> 
        <system value="http://unitsofmeasure.org"/>  
        <code value="mm"/> 
      </valueQuantity> 
    </property> 
    <property> 
      <type> 
        <coding> 
          <code value="depth"/> 
        </coding> 
      </type> 
      <valueQuantity> 
        <value value="23.5"/> 
        <unit value="mm"/> 
        <system value="http://unitsofmeasure.org"/>  
        <code value="mm"/> 
      </valueQuantity> 
    </property> 
        <!--    inner packaging    -->
    <packaging> 
      <type> 
        <coding> 
          <system value="http://ema.europa.eu/example/packageitemcontainertype"/> 
          <code value="Blister"/> 
        </coding> 
      </type> 
      <quantity value="1"/> 
      <material> 
        <coding> 
          <system value="http://ema.europa.eu/example/packageItemContainerMaterial"/> 
          <code value="PVC"/> 
        </coding> 
      </material> 
      <material> 
        <coding> 
          <system value="http://ema.europa.eu/example/packageItemContainerMaterial"/> 
          <code value="PVDC"/> 
        </coding> 
      </material> 
      <material> 
        <coding> 
          <system value="http://ema.europa.eu/example/packageItemContainerMaterial"/> 
          <code value="alu"/> 
        </coding> 
      </material> 
      <shelfLifeStorage> 
        <type> 
          <coding> 
            <system value="http://ema.europa.eu/example/shelfLifeTypePlaceHolder"/> 
            <code value="ShelfLifeofPackagedMedicinalProduct"/> 
          </coding> 
        </type> 
        <periodDuration> 
          <value value="3"/> 
          <unit value="year"/> 
          <system value="http://unitsofmeasure.org"/>  
          <code value="a"/> 
        </periodDuration> 
        <specialPrecautionsForStorage> 
          <coding> 
            <system value="http://ema.europa.eu/example/specialprecautionsforstorage"/> 
            <code value="none"/> 
          </coding> 
        </specialPrecautionsForStorage> 
      </shelfLifeStorage> 
      <manufacturer> 
        <reference value="Organization/example"/> 
      </manufacturer> 
      <property> 
        <type> 
          <coding> 
            <code value="height"/> 
          </coding> 
        </type> 
        <valueQuantity> 
          <value value="45"/> 
          <unit value="mm"/> 
          <system value="http://unitsofmeasure.org"/>  
          <code value="mm"/> 
        </valueQuantity> 
      </property> 
      <property> 
        <type> 
          <coding> 
            <code value="width"/> 
          </coding> 
        </type> 
        <valueQuantity> 
          <value value="35"/> 
          <unit value="mm"/> 
          <system value="http://unitsofmeasure.org"/>  
          <code value="mm"/> 
        </valueQuantity> 
      </property> 
      <containedItem> 
        <item> 
          <reference> 
          <reference value="ManufacturedItemDefinition/tablet"/> 
          </reference> 
        </item> 
            <!--    10 tablets in the blister pack    -->
        <amount> 
          <value value="10"/> 
        </amount> 
      </containedItem> 
    </packaging> 
  </packaging> 

string


</

PackagedProductDefinition


>

A
valid
display
for
the
concept
if
the
system
wishes
to
display
this
to
a
user
Note:
the
correct
behaviour
of
validation
with
regard
to
language
for
Coding.display
items
is
currently
undefined,
and
further
development
and
testing
may
lead
to
specific
requirements
or
recommendations
in
subsequent
releases
   

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.