Structured Data Capture
3.0.0-preview - STU 3 International flag

This page is part of the Structured Data Capture FHIR IG (v3.0.0-preview: STU 3 Draft) based on FHIR R4. The current version which supercedes this version is 3.0.0. For a full list of available versions, see the Directory of published versions

: Assemble Expectation Codes - JSON Representation

Page standards status: Trial-use Maturity Level: 3

Raw json | Download


{
  "resourceType" : "CodeSystem",
  "id" : "assemble-expectation",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Properties</b></p><table class=\"grid\"><tr><td><b>Code</b></td><td><b>URL</b></td><td><b>Type</b></td><td><b>Description</b></td></tr><tr><td>notSelectable</td><td>http://hl7.org/fhir/concept-properties#notSelectable</td><td>boolean</td><td>Indicates that the concept is abstract.  It can be used for searching, but cannot appear in instances</td></tr><tr><td>parent</td><td>http://hl7.org/fhir/concept-properties#parent</td><td>code</td><td>Indicates a parent concept that can subsume this concept</td></tr></table><p>This code system http://hl7.org/fhir/uv/sdc/CodeSystem/assemble-expectation 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><td><b>Not Selectable</b></td><td><b>Parent</b></td></tr><tr><td style=\"white-space:nowrap\">assembly<a name=\"assemble-expectation-assembly\"> </a></td><td>Assembly needed</td><td>An abstract code that subsumes all codes for Questionnaires that require assembly prior to use</td><td>true</td><td/></tr><tr><td style=\"white-space:nowrap\">independent<a name=\"assemble-expectation-independent\"> </a></td><td>No assembly needed</td><td>An abstract code that subsumes all codes for Questionnaires that DO NOT require assembly prior to use</td><td>true</td><td/></tr><tr><td style=\"white-space:nowrap\">root<a name=\"assemble-expectation-root\"> </a></td><td>Root Questionnaires</td><td>An abstract code that subsumes all codes for Questionnaires that can act as the root for a QuestionnaireResponse</td><td>true</td><td/></tr><tr><td style=\"white-space:nowrap\">child<a name=\"assemble-expectation-child\"> </a></td><td>Child Questionnaires</td><td>An abstract code that subsumes all codes for Questionnaires that can act as subQuestionnaires</td><td>true</td><td/></tr><tr><td style=\"white-space:nowrap\">assemble-root-or-child<a name=\"assemble-expectation-assemble-root-or-child\"> </a></td><td>Assembly-required root or child</td><td>This Questionnaire can be used as the root of an assembly operation or as a child in an assembly process.  In either case, assembly is required before use.</td><td>false</td><td>assembly, root, child</td></tr><tr><td style=\"white-space:nowrap\">assemble-root<a name=\"assemble-expectation-assemble-root\"> </a></td><td>Assembly-required root</td><td>This Questionnaire can be used as the root of an assembly operation, but requires assembly before use.  It is not intended for use as a child module.</td><td>false</td><td>assembly, root</td></tr><tr><td style=\"white-space:nowrap\">assemble-child<a name=\"assemble-expectation-assemble-child\"> </a></td><td>Assembly required child</td><td>This Questionnaire is intended to be used as an assembly operation but cannot be used as a root - it must always be a child module</td><td>false</td><td>assembly, child</td></tr><tr><td style=\"white-space:nowrap\">independent-root-or-child<a name=\"assemble-expectation-independent-root-or-child\"> </a></td><td>Assembled root-or-child</td><td>This Questionnaire can be used without assembly and be used directly, but is also safe for use as a child module</td><td>false</td><td>independent, root, child</td></tr><tr><td style=\"white-space:nowrap\">independent-child<a name=\"assemble-expectation-independent-child\"> </a></td><td>Assembled child</td><td>This Questionnaire can be used without assembly, is also safe for use as a child module and is only intended for use as a child</td><td>false</td><td>independent, child</td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger" : 3,
      "_valueInteger" : {
        "extension" : [
          {
            "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
            "valueCanonical" : "http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"
          }
        ]
      }
    },
    {
      "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/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"
          }
        ]
      }
    }
  ],
  "url" : "http://hl7.org/fhir/uv/sdc/CodeSystem/assemble-expectation",
  "version" : "3.0.0-preview",
  "name" : "AssembleExpectation",
  "title" : "Assemble Expectation Codes",
  "status" : "draft",
  "date" : "2022-02-16T19:40:22+11:00",
  "publisher" : "HL7 International - FHIR Infrastructure Work Group",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://hl7.org/Special/committees/fiwg"
        }
      ]
    }
  ],
  "description" : "A set of codes that reflect the relevance of the Questionnaire to the $assemble operation - specifically, whether the form needs to be assembled, whether the form can be referenced as a subQuestionnaire and whether the form can be used as the 'root' of a QuestionnaireResponse.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code" : "001"
        }
      ]
    }
  ],
  "caseSensitive" : true,
  "content" : "complete",
  "property" : [
    {
      "code" : "notSelectable",
      "uri" : "http://hl7.org/fhir/concept-properties#notSelectable",
      "description" : "Indicates that the concept is abstract.  It can be used for searching, but cannot appear in instances",
      "type" : "boolean"
    },
    {
      "code" : "parent",
      "uri" : "http://hl7.org/fhir/concept-properties#parent",
      "description" : "Indicates a parent concept that can subsume this concept",
      "type" : "code"
    }
  ],
  "concept" : [
    {
      "code" : "assembly",
      "display" : "Assembly needed",
      "definition" : "An abstract code that subsumes all codes for Questionnaires that require assembly prior to use",
      "property" : [
        {
          "code" : "notSelectable",
          "valueBoolean" : true
        }
      ]
    },
    {
      "code" : "independent",
      "display" : "No assembly needed",
      "definition" : "An abstract code that subsumes all codes for Questionnaires that DO NOT require assembly prior to use",
      "property" : [
        {
          "code" : "notSelectable",
          "valueBoolean" : true
        }
      ]
    },
    {
      "code" : "root",
      "display" : "Root Questionnaires",
      "definition" : "An abstract code that subsumes all codes for Questionnaires that can act as the root for a QuestionnaireResponse",
      "property" : [
        {
          "code" : "notSelectable",
          "valueBoolean" : true
        }
      ]
    },
    {
      "code" : "child",
      "display" : "Child Questionnaires",
      "definition" : "An abstract code that subsumes all codes for Questionnaires that can act as subQuestionnaires",
      "property" : [
        {
          "code" : "notSelectable",
          "valueBoolean" : true
        }
      ]
    },
    {
      "code" : "assemble-root-or-child",
      "display" : "Assembly-required root or child",
      "definition" : "This Questionnaire can be used as the root of an assembly operation or as a child in an assembly process.  In either case, assembly is required before use.",
      "property" : [
        {
          "code" : "notSelectable",
          "valueBoolean" : false
        },
        {
          "code" : "parent",
          "valueCode" : "assembly"
        },
        {
          "code" : "parent",
          "valueCode" : "root"
        },
        {
          "code" : "parent",
          "valueCode" : "child"
        }
      ]
    },
    {
      "code" : "assemble-root",
      "display" : "Assembly-required root",
      "definition" : "This Questionnaire can be used as the root of an assembly operation, but requires assembly before use.  It is not intended for use as a child module.",
      "property" : [
        {
          "code" : "notSelectable",
          "valueBoolean" : false
        },
        {
          "code" : "parent",
          "valueCode" : "assembly"
        },
        {
          "code" : "parent",
          "valueCode" : "root"
        }
      ]
    },
    {
      "code" : "assemble-child",
      "display" : "Assembly required child",
      "definition" : "This Questionnaire is intended to be used as an assembly operation but cannot be used as a root - it must always be a child module",
      "property" : [
        {
          "code" : "notSelectable",
          "valueBoolean" : false
        },
        {
          "code" : "parent",
          "valueCode" : "assembly"
        },
        {
          "code" : "parent",
          "valueCode" : "child"
        }
      ]
    },
    {
      "code" : "independent-root-or-child",
      "display" : "Assembled root-or-child",
      "definition" : "This Questionnaire can be used without assembly and be used directly, but is also safe for use as a child module",
      "property" : [
        {
          "code" : "notSelectable",
          "valueBoolean" : false
        },
        {
          "code" : "parent",
          "valueCode" : "independent"
        },
        {
          "code" : "parent",
          "valueCode" : "root"
        },
        {
          "code" : "parent",
          "valueCode" : "child"
        }
      ]
    },
    {
      "code" : "independent-child",
      "display" : "Assembled child",
      "definition" : "This Questionnaire can be used without assembly, is also safe for use as a child module and is only intended for use as a child",
      "property" : [
        {
          "code" : "notSelectable",
          "valueBoolean" : false
        },
        {
          "code" : "parent",
          "valueCode" : "independent"
        },
        {
          "code" : "parent",
          "valueCode" : "child"
        }
      ]
    }
  ]
}