HL7 Terminology
2.0.0 - Publication

This page is part of the HL7 Terminology (v2.0.0: Release) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions

: QueryParameterValue - JSON Representation

Raw json | Download


{
  "resourceType" : "CodeSystem",
  "id" : "v3-QueryParameterValue",
  "language" : "en",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\" xml:lang=\"en\" lang=\"en\"><p><b>Properties</b></p><table class=\"grid\"><tr><td><b>Code</b></td><td><b>URL</b></td><td><b>Description</b></td><td><b>Type</b></td></tr><tr><td>Specializes</td><td/><td>The child code is a more narrow version of the concept represented by the parent code.  I.e. Every child concept is also a valid parent concept.  Used to allow determination of subsumption.  Must be transitive, irreflexive, antisymmetric.</td><td>Coding</td></tr><tr><td>Generalizes</td><td/><td>Inverse of Specializes.  Only included as a derived relationship.</td><td>Coding</td></tr><tr><td>internalId</td><td>http://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-id</td><td>The internal identifier for the concept in the HL7 Access database repository.</td><td>code</td></tr><tr><td>notSelectable</td><td>http://hl7.org/fhir/concept-properties#notSelectable</td><td>Indicates that the code is abstract - only intended to be used as a selector for other concepts</td><td>boolean</td></tr><tr><td>status</td><td>http://hl7.org/fhir/concept-properties#status</td><td>Designation of a concept's state. Normally is not populated unless the state is retired.</td><td>code</td></tr></table><p>This code system http://terminology.hl7.org/CodeSystem/v3-QueryParameterValue defines the following codes:</p><table class=\"codes\"><tr><td><b>Lvl</b></td><td style=\"white-space:nowrap\"><b>Code</b></td><td><b>Display</b></td><td><b>Definition</b></td><td><b>internalId</b></td><td><b>Not Selectable</b></td><td><b>status</b></td></tr><tr><td>1</td><td style=\"white-space:nowrap\">_DispenseQueryFilterCode<a name=\"v3-QueryParameterValue-_DispenseQueryFilterCode\"> </a></td><td>dispense query filter code</td><td>**Description:**Filter codes used to manage volume of dispenses returned by a parameter-based queries.</td><td>23299</td><td>true</td><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  ALLDISP<a name=\"v3-QueryParameterValue-ALLDISP\"> </a></td><td>all dispenses</td><td>**Description:**Returns all dispenses to date for a prescription.</td><td>23300</td><td/><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  LASTDISP<a name=\"v3-QueryParameterValue-LASTDISP\"> </a></td><td>last dispense</td><td>**Description:**Returns the most recent dispense for a prescription.</td><td>23301</td><td/><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  NODISP<a name=\"v3-QueryParameterValue-NODISP\"> </a></td><td>no dispense</td><td>**Description:**Returns no dispense for a prescription.</td><td>23302</td><td/><td>active</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">_OrderFilterCode<a name=\"v3-QueryParameterValue-_OrderFilterCode\"> </a></td><td>_OrderFilterCode</td><td>Filter codes used to manage types of orders being returned by a parameter-based query.</td><td>23616</td><td>true</td><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  AO<a name=\"v3-QueryParameterValue-AO\"> </a></td><td>all orders</td><td>Return all orders.</td><td>23617</td><td/><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  ONR<a name=\"v3-QueryParameterValue-ONR\"> </a></td><td>orders without results</td><td>Return only those orders that do not have results.</td><td>23619</td><td/><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  OWR<a name=\"v3-QueryParameterValue-OWR\"> </a></td><td>orders with results</td><td>Return only those orders that have results.</td><td>23618</td><td/><td>active</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">_PrescriptionDispenseFilterCode<a name=\"v3-QueryParameterValue-_PrescriptionDispenseFilterCode\"> </a></td><td>Prescription Dispense Filter Code</td><td>A &quot;helper&quot; vocabulary used to construct complex query filters based on how and whether a prescription has been dispensed.</td><td>21537</td><td>true</td><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  C<a name=\"v3-QueryParameterValue-C\"> </a></td><td>Completely dispensed</td><td>Filter to only include SubstanceAdministration orders which have no remaining quantity authorized to be dispensed.</td><td>21540</td><td/><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  N<a name=\"v3-QueryParameterValue-N\"> </a></td><td>Never Dispensed</td><td>Filter to only include SubstanceAdministration orders which have no fulfilling supply events performed.</td><td>21538</td><td/><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  R<a name=\"v3-QueryParameterValue-R\"> </a></td><td>Dispensed with remaining fills</td><td>Filter to only include SubstanceAdministration orders which have had at least one fulfilling supply event, but which still have outstanding quantity remaining to be authorized.</td><td>21539</td><td/><td>active</td></tr><tr><td>1</td><td style=\"white-space:nowrap\">_QueryParameterValue<a name=\"v3-QueryParameterValue-_QueryParameterValue\"> </a></td><td>QueryParameterValue</td><td>**Description:**Indicates how result sets should be filtered based on whether they have associated issues.</td><td>21986</td><td>true</td><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  ISSFA<a name=\"v3-QueryParameterValue-ISSFA\"> </a></td><td>all</td><td>**Description:**Result set should not be filtered based on the presence of issues.</td><td>21987</td><td/><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  ISSFI<a name=\"v3-QueryParameterValue-ISSFI\"> </a></td><td>with issues</td><td>**Description:**Result set should be filtered to only include records with associated issues.</td><td>21988</td><td/><td>active</td></tr><tr><td>2</td><td style=\"white-space:nowrap\">  ISSFU<a name=\"v3-QueryParameterValue-ISSFU\"> </a></td><td>with unmanaged issues</td><td>**Description:**Result set should be filtered to only include records with associated unmanaged issues.</td><td>21989</td><td/><td>active</td></tr></table></div>"
  },
  "url" : "http://terminology.hl7.org/CodeSystem/v3-QueryParameterValue",
  "identifier" : [
    {
      "system" : "urn:ietf:rfc:3986",
      "value" : "urn:oid:2.16.840.1.113883.5.1096"
    }
  ],
  "version" : "2.0.0",
  "name" : "QueryParameterValue",
  "title" : "QueryParameterValue",
  "status" : "active",
  "date" : "2019-03-20",
  "publisher" : "HL7",
  "contact" : [
    {
      "name" : "HL7 Modeling and Methodology Workgroup"
    }
  ],
  "description" : "The domain of coded values used as parameters within QueryByParameter queries.",
  "hierarchyMeaning" : "is-a",
  "content" : "complete",
  "property" : [
    {
      "extension" : [
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry",
          "valueCode" : "antisymmetric"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity",
          "valueCode" : "transitive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity",
          "valueCode" : "irreflexive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable",
          "valueBoolean" : true
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind",
          "valueCode" : "Specializes"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName",
          "valueString" : "Generalizes"
        }
      ],
      "code" : "Specializes",
      "description" : "The child code is a more narrow version of the concept represented by the parent code.  I.e. Every child concept is also a valid parent concept.  Used to allow determination of subsumption.  Must be transitive, irreflexive, antisymmetric.",
      "type" : "Coding"
    },
    {
      "extension" : [
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-symmetry",
          "valueCode" : "antisymmetric"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-transitivity",
          "valueCode" : "transitive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-reflexivity",
          "valueCode" : "irreflexive"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-isNavigable",
          "valueBoolean" : true
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-relationshipKind",
          "valueCode" : "Generalizes"
        },
        {
          "url" : "http://terminology.hl7.org/StructureDefinition/ext-mif-relationship-inverseName",
          "valueString" : "Specializes"
        }
      ],
      "code" : "Generalizes",
      "description" : "Inverse of Specializes.  Only included as a derived relationship.",
      "type" : "Coding"
    },
    {
      "code" : "internalId",
      "uri" : "http://terminology.hl7.org/CodeSystem/utg-concept-properties#v3-internal-id",
      "description" : "The internal identifier for the concept in the HL7 Access database repository.",
      "type" : "code"
    },
    {
      "code" : "notSelectable",
      "uri" : "http://hl7.org/fhir/concept-properties#notSelectable",
      "description" : "Indicates that the code is abstract - only intended to be used as a selector for other concepts",
      "type" : "boolean"
    },
    {
      "code" : "status",
      "uri" : "http://hl7.org/fhir/concept-properties#status",
      "description" : "Designation of a concept's state. Normally is not populated unless the state is retired.",
      "type" : "code"
    }
  ],
  "concept" : [
    {
      "code" : "_DispenseQueryFilterCode",
      "display" : "dispense query filter code",
      "definition" : "**Description:**Filter codes used to manage volume of dispenses returned by a parameter-based queries.",
      "property" : [
        {
          "code" : "notSelectable",
          "valueBoolean" : true
        },
        {
          "code" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "23299"
        }
      ],
      "concept" : [
        {
          "code" : "ALLDISP",
          "display" : "all dispenses",
          "definition" : "**Description:**Returns all dispenses to date for a prescription.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "active"
            },
            {
              "code" : "internalId",
              "valueCode" : "23300"
            }
          ]
        },
        {
          "code" : "LASTDISP",
          "display" : "last dispense",
          "definition" : "**Description:**Returns the most recent dispense for a prescription.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "active"
            },
            {
              "code" : "internalId",
              "valueCode" : "23301"
            }
          ]
        },
        {
          "code" : "NODISP",
          "display" : "no dispense",
          "definition" : "**Description:**Returns no dispense for a prescription.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "active"
            },
            {
              "code" : "internalId",
              "valueCode" : "23302"
            }
          ]
        }
      ]
    },
    {
      "code" : "_OrderFilterCode",
      "display" : "_OrderFilterCode",
      "definition" : "Filter codes used to manage types of orders being returned by a parameter-based query.",
      "property" : [
        {
          "code" : "notSelectable",
          "valueBoolean" : true
        },
        {
          "code" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "23616"
        }
      ],
      "concept" : [
        {
          "code" : "AO",
          "display" : "all orders",
          "definition" : "Return all orders.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "active"
            },
            {
              "code" : "internalId",
              "valueCode" : "23617"
            }
          ]
        },
        {
          "code" : "ONR",
          "display" : "orders without results",
          "definition" : "Return only those orders that do not have results.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "active"
            },
            {
              "code" : "internalId",
              "valueCode" : "23619"
            }
          ]
        },
        {
          "code" : "OWR",
          "display" : "orders with results",
          "definition" : "Return only those orders that have results.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "active"
            },
            {
              "code" : "internalId",
              "valueCode" : "23618"
            }
          ]
        }
      ]
    },
    {
      "code" : "_PrescriptionDispenseFilterCode",
      "display" : "Prescription Dispense Filter Code",
      "definition" : "A \"helper\" vocabulary used to construct complex query filters based on how and whether a prescription has been dispensed.",
      "property" : [
        {
          "code" : "notSelectable",
          "valueBoolean" : true
        },
        {
          "code" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "21537"
        }
      ],
      "concept" : [
        {
          "code" : "C",
          "display" : "Completely dispensed",
          "definition" : "Filter to only include SubstanceAdministration orders which have no remaining quantity authorized to be dispensed.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "active"
            },
            {
              "code" : "internalId",
              "valueCode" : "21540"
            }
          ]
        },
        {
          "code" : "N",
          "display" : "Never Dispensed",
          "definition" : "Filter to only include SubstanceAdministration orders which have no fulfilling supply events performed.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "active"
            },
            {
              "code" : "internalId",
              "valueCode" : "21538"
            }
          ]
        },
        {
          "code" : "R",
          "display" : "Dispensed with remaining fills",
          "definition" : "Filter to only include SubstanceAdministration orders which have had at least one fulfilling supply event, but which still have outstanding quantity remaining to be authorized.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "active"
            },
            {
              "code" : "internalId",
              "valueCode" : "21539"
            }
          ]
        }
      ]
    },
    {
      "code" : "_QueryParameterValue",
      "display" : "QueryParameterValue",
      "definition" : "**Description:**Indicates how result sets should be filtered based on whether they have associated issues.",
      "property" : [
        {
          "code" : "notSelectable",
          "valueBoolean" : true
        },
        {
          "code" : "status",
          "valueCode" : "active"
        },
        {
          "code" : "internalId",
          "valueCode" : "21986"
        }
      ],
      "concept" : [
        {
          "code" : "ISSFA",
          "display" : "all",
          "definition" : "**Description:**Result set should not be filtered based on the presence of issues.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "active"
            },
            {
              "code" : "internalId",
              "valueCode" : "21987"
            }
          ]
        },
        {
          "code" : "ISSFI",
          "display" : "with issues",
          "definition" : "**Description:**Result set should be filtered to only include records with associated issues.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "active"
            },
            {
              "code" : "internalId",
              "valueCode" : "21988"
            }
          ]
        },
        {
          "code" : "ISSFU",
          "display" : "with unmanaged issues",
          "definition" : "**Description:**Result set should be filtered to only include records with associated unmanaged issues.",
          "property" : [
            {
              "code" : "status",
              "valueCode" : "active"
            },
            {
              "code" : "internalId",
              "valueCode" : "21989"
            }
          ]
        }
      ]
    }
  ]
}