R4 Draft for Comment

This page is part of the FHIR Specification (v3.2.0: R4 Ballot 1). 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: R4 R3

V3-QueryParameterValue.cs.json

Vocabulary Work GroupMaturity Level: N/ABallot Status: Informative

Raw JSON (canonical form)

The domain of coded values used as parameters within QueryByParameter queries.

{
  "resourceType": "CodeSystem",
  "id": "v3-QueryParameterValue",
  "meta": {
    "lastUpdated": "2017-07-31T00:00:00.000+10:00"
  },
  "text": {
    "status": "generated",
    "div": "<div>!-- Snipped for Brevity --></div>"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-ballot-status",
      "valueString": "External"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 0
    }
  ],
  "url": "http://hl7.org/fhir/v3/QueryParameterValue",
  "identifier": {
    "system": "urn:ietf:rfc:3986",
    "value": "urn:oid:2.16.840.1.113883.5.1096"
  },
  "version": "2017-07-31",
  "name": "v3 Code System QueryParameterValue",
  "status": "active",
  "experimental": false,
  "date": "2017-07-31T00:00:00+10:00",
  "publisher": "HL7, Inc",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org"
        }
      ]
    }
  ],
  "description": " The domain of coded values used as parameters within QueryByParameter queries.",
  "caseSensitive": true,
  "valueSet": "http://hl7.org/fhir/ValueSet/v3-QueryParameterValue",
  "hierarchyMeaning": "is-a",
  "content": "complete",
  "property": [
    {
      "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"
    }
  ],
  "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
        }
      ],
      "concept": [
        {
          "code": "ALLDISP",
          "display": "all dispenses",
          "definition": "Description:Returns all dispenses to date for a prescription."
        },
        {
          "code": "LASTDISP",
          "display": "last dispense",
          "definition": "Description:Returns the most recent dispense for a prescription."
        },
        {
          "code": "NODISP",
          "display": "no dispense",
          "definition": "Description:Returns no dispense for a prescription."
        }
      ]
    },
    {
      "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
        }
      ],
      "concept": [
        {
          "code": "AO",
          "display": "all orders",
          "definition": "Return all orders."
        },
        {
          "code": "ONR",
          "display": "orders without results",
          "definition": "Return only those orders that do not have results."
        },
        {
          "code": "OWR",
          "display": "orders with results",
          "definition": "Return only those orders that have results."
        }
      ]
    },
    {
      "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
        }
      ],
      "concept": [
        {
          "code": "C",
          "display": "Completely dispensed",
          "definition": "Filter to only include SubstanceAdministration orders which have no remaining quantity authorized to be dispensed."
        },
        {
          "code": "N",
          "display": "Never Dispensed",
          "definition": "Filter to only include SubstanceAdministration orders which have no fulfilling supply events performed."
        },
        {
          "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."
        }
      ]
    },
    {
      "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
        }
      ],
      "concept": [
        {
          "code": "ISSFA",
          "display": "all",
          "definition": "Description:Result set should not be filtered based on the presence of issues."
        },
        {
          "code": "ISSFI",
          "display": "with issues",
          "definition": "Description:Result set should be filtered to only include records with associated issues."
        },
        {
          "code": "ISSFU",
          "display": "with unmanaged issues",
          "definition": "Description:Result set should be filtered to only include records with associated unmanaged issues."
        }
      ]
    }
  ]
}

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.