FHIR Release 3 (STU) R5 Final QA

This page is part of the FHIR Specification (v3.0.2: STU (v5.0.0-draft-final: Final QA Preview for R5 - see ballot notes 3). ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Content Detailed Descriptions Mappings XML JSON

Example CodeSystem/codesystem-hierarchy-meaning (XML)

Extension: ADXP-additionalLocator URL for this extension: http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
FHIR Terminology Infrastructure Work Group   Maturity Level : 1 N/A Standards Status : Informative Use Context : Any

Summary Name Flags Card. Type Description & Constraints extension Raw XML 0..* string ( canonical form URL = http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator ADXP-additionalLocator: This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can + also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). Use on data type: Address.line Documentation for this format see XML Format Specification Full Structure )

Name Flags Card. Type Description & Constraints extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator ADXP-additionalLocator: This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from the location, rather than specifying a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). Use on data type: Address.line url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator" valueString 0..1 string Value of extension Documentation for this format

XML Template Definition for Code SystemCodeSystemHierarchyMeaning

<!-- ADXP-additionalLocator -->
<?xml version="1.0" encoding="UTF-8"?>


< xmlns="http://hl7.org/fhir"
     url="" >
  <!-- from Element: 
 <
</extension>
JSON
Template
  
{ // 
  // from Element: 
    "
    ],
    " 
    "
  }
Summary

<CodeSystem xmlns="http://hl7.org/fhir">
  <id value="codesystem-hierarchy-meaning"/> 
  <meta> 
    <lastUpdated value="2023-03-01T23:03:57.298+11:00"/> 
    <profile value="http://hl7.org/fhir/StructureDefinition/shareablecodesystem"/> 
  </meta> 
  <text> 
    <status value="generated"/> 
    <div xmlns="http://www.w3.org/1999/xhtml">
      <p> This code system 
        <code> http://hl7.org/fhir/codesystem-hierarchy-meaning</code>  defines the following codes:
      </p> 
      <table class="codes">
        <tr> 
          <td style="white-space:nowrap">
            <b> Code</b> 
          </td> 
          <td> 
            <b> Display</b> 
          </td> 
          <td> 
            <b> Definition</b> 
          </td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">grouped-by
            <a name="codesystem-hierarchy-meaning-grouped-by"> </a> 
          </td> 
          <td> Grouped By</td> 
          <td> No particular relationship between the concepts can be assumed, except what can
             be determined by inspection of the definitions of the elements (possible reasons
             to use this: importing from a source where this is not defined, or where various
             parts of the hierarchy have different meanings).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">is-a
            <a name="codesystem-hierarchy-meaning-is-a"> </a> 
          </td> 
          <td> Is-A</td> 
          <td> A hierarchy where the child concepts have an IS-A relationship with the parents

             - that is, all the properties of the parent are also true for its child concepts.
             Not that is-a is a property of the concepts, so additional subsumption relationships
             may be defined using properties.</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">part-of
            <a name="codesystem-hierarchy-meaning-part-of"> </a> 
          </td> 
          <td> Part Of</td> 
          <td> Child elements list the individual parts of a composite whole (e.g. body site).</td> 
        </tr> 
        <tr> 
          <td style="white-space:nowrap">classified-with
            <a name="codesystem-hierarchy-meaning-classified-with"> </a> 
          </td> 
          <td> Classified With</td> 
          <td> Child concepts in the hierarchy may have only one parent, and there is a presumption

             that the code system is a &quot;closed world&quot; meaning all things must be in
             the hierarchy. This results in concepts such as &quot;not otherwise classified.&quot;.</td> 
        </tr> 
      </table> 
    </div> 
  </text> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-wg">
    <valueCode value="vocab"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status">
    <valueCode value="normative"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-normative-version">
    <valueCode value="4.0.0"/> 
  </extension> 
  <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm">
    <valueInteger value="5"/> 
  </extension> 
  <url value="http://hl7.org/fhir/codesystem-hierarchy-meaning"/> 
  <identifier> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.4.785"/> 
  </identifier> 
  <identifier> 
    <use value="old"/> 
    <system value="urn:ietf:rfc:3986"/> 
    <value value="urn:oid:2.16.840.1.113883.4.642.1.768"/> 
  </identifier> 
  <version value="5.0.0-draft-final"/> 
  <name value="CodeSystemHierarchyMeaning"/> 
  <title value="Code System Hierarchy Meaning"/> 
  <status value="active"/> 
  <experimental value="false"/> 
  <date value="2021-01-05T10:01:24+11:00"/> 
  <publisher value="HL7 (FHIR Project)"/> 
  <contact> 
    <telecom> 
      <system value="url"/> 
      <value value="http://hl7.org/fhir"/> 
    </telecom> 
    <telecom> 
      <system value="email"/> 
      <value value="fhir@lists.hl7.org"/> 
    </telecom> 
  </contact> 
  <description value="The meaning of the hierarchy of concepts in a code system."/> 
  <jurisdiction> 
    <coding> 
      <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> 
      <code value="001"/> 
      <display value="World"/> 
    </coding> 
  </jurisdiction> 
  <caseSensitive value="true"/> 
  <valueSet value="http://hl7.org/fhir/ValueSet/codesystem-hierarchy-meaning"/> 
  <content value="complete"/> 
  <concept> 
    <code value="grouped-by"/> 
    <display value="Grouped By"/> 
    <definition value="No particular relationship between the concepts can be assumed, except what can

     be determined by inspection of the definitions of the elements (possible reasons
     to use this: importing from a source where this is not defined, or where various
     parts of the hierarchy have different meanings)."/> 
  </concept> 
  <concept> 
    <code value="is-a"/> 
    <display value="Is-A"/> 
    <definition value="A hierarchy where the child concepts have an IS-A relationship with the parents

     - that is, all the properties of the parent are also true for its child concepts.
     Not that is-a is a property of the concepts, so additional subsumption relationships
     may be defined using properties."/> 
  </concept> 
  <concept> 
    <code value="part-of"/> 
    <display value="Part Of"/> 
    <definition value="Child elements list the individual parts of a composite whole (e.g. body site)."/> 
  </concept> 
  <concept> 
    <code value="classified-with"/> 
    <display value="Classified With"/> 
    <definition value="Child concepts in the hierarchy may have only one parent, and there is a presumption

     that the code system is a &quot;closed world&quot; meaning all things must be in
     the hierarchy. This results in concepts such as &quot;not otherwise classified.&quot;."/> 
  </concept> 

Name
Flags
Card.
Type
Description
&
Constraints


</

CodeSystem


>


extension
0..*
string
URL
=
http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator
ADXP-additionalLocator:
This
can
be
a
unit
designator,
such
as
apartment
number,
suite
number,
or
floor.
There
may
be
several
unit
designators
in
an
address
(e.g.,
"3rd
floor,
Appt.
342").
This
can
also
be
a
designator
pointing
away
from
the
location,
rather
than
specifying
a
smaller
location
within
some
larger
one
(e.g.,
Dutch
"t.o."
means
"opposite
to"
for
house
boats
located
across
the
street
facing
houses).
Use
on
data
type:
Address.line
Documentation
for
this
format



Full Structure Name Flags Card. Type Description & Constraints extension 0..* Extension URL = http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator ADXP-additionalLocator: This can be a unit designator, such as apartment number, suite number, or floor. There may be several unit designators in an address (e.g., "3rd floor, Appt. 342"). This can also be a designator pointing away from Usage note: every effort has been made to ensure that the location, rather than specifying examples are correct and useful, but they are not a smaller location within some larger one (e.g., Dutch "t.o." means "opposite to" for house boats located across the street facing houses). Use on data type: Address.line url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-ADXP-additionalLocator" valueString 0..1 string Value normative part of extension Documentation for this format XML Template the specification.

<!-- ADXP-additionalLocator --> < xmlns="http://hl7.org/fhir" url="" > <!-- from Element: < </extension>
JSON Template { // // from Element: " ], " " }   Constraints ele-1 : All FHIR elements must have a @value or children (xpath: @value|f:*|h:div ) ext-1 : Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]) )