R6 Release 5 Ballot (3rd Draft)

This page is part of the FHIR Specification v6.0.0-ballot3: Release 6 (v5.0.0-ballot: R5 Ballot (3rd Draft) (see - see Ballot Notes ballot notes ). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions

Content Examples Detailed Descriptions Mappings Operations Search Params Profiles Extensions 11.11 Resource FormularyItem - Content

Example CodeSystem/measure-definition-example (Turtle)

  Trial Use
Pharmacy Clinical Quality Information Work Group Maturity Level : 0 N/A Standards Status : Informative Security Category : Business Compartments : No defined compartments
This resource describes a product or service that is available through a program and includes the conditions and constraints of availability. All of the information in this resource is specific to the inclusion of the item in the formulary and is not inherent to the item itself. 11.11.1 Scope and Usage A FormularyItem is a product or service that is available through a program and includes the conditions and constraints of availability, e.g. amount limits, categorization, cost limits, and other requirements for use. This resource describes the program-specific information for a product or service. This information is specific to the inclusion of the item in the formulary and is not inherent to the item itself. This diagram was created for the PDEX US Drug Formulary Implementation Guide but it shows where FormularyItem would fit in a drug context. If you abstract that to generic Insurance Plans to the left and to a set of resources that can be referenced to the right, that is the concept behind the FormularyItem resource. 11.11.2 References to this Resource No references for this Resource. 11.11.3 Resource Content

Structure Name Flags Card. Type Description & Constraints FormularyItem TU DomainResource Definition of a FormularyItem Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension identifier Σ 0..* Identifier Business identifier for this formulary item code Σ 0..1 CodeableConcept Codes that identify this formulary item Binding: SNOMED CT Medication Codes ( Example ) status ?! Σ 0..1 code active | entered-in-error | inactive Binding: FormularyItem Status Codes Raw Turtle ( Required (+ also see Turtle/RDF Format Specification ) Documentation for this format See the Extensions for this resource

UML Diagram ( Legend ) FormularyItem ( DomainResource ) Business identifier Definition for this formulary item identifier : Identifier [0..*] A code (or set of codes) that specify the product or service that is identified by this formulary item code : CodeableConcept [0..1] « null (Strength=Example) SNOMEDCTMedicationCodes ?? » The validity about the information of the formulary item and not of the underlying product or service itself (this element modifies the meaning of other elements) status : code [0..1] « null (Strength=Required) FormularyItemStatusCodes ! » XML Template < <!-- from --> <!-- from --> <</identifier> <</code> < </FormularyItem> JSON Template { "resourceType" : "", // from // from " " " } Turtle Template Code SystemMeasureDefinitionExample

@prefix fhir: <http://hl7.org/fhir/> . 
@prefix fhir: <http://hl7.org/fhir/> .
@prefix rdfs: <http://www.w3.org/2000/01/rdf-schema#> .


# - resource -------------------------------------------------------------------

[] a fhir:CodeSystem;
  fhir:Resource.id [ fhir:value "measure-definition-example"];
  fhir:Resource.meta [
     fhir:Meta.lastUpdated [ fhir:value "2022-09-10T04:52:37.223+10:00" ];
     fhir:Meta.profile [ fhir:value "http://hl7.org/fhir/StructureDefinition/shareablecodesystem" ]
  ];
  fhir:DomainResource.text [
     fhir:Narrative.status [ fhir:value "generated" ]
  ];
  fhir:DomainResource.extension [
     fhir:Extension.url [ fhir:value "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg" ];
     fhir:Extension.value [ fhir:value "cqi" ]
  ];
  fhir:CanonicalResource.url [ fhir:value "http://terminology.hl7.org/CodeSystem/measure-definition-example"];
  fhir:CanonicalResource.identifier [
     fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ];
     fhir:Identifier.value [ fhir:value "urn:oid:2.16.840.1.113883.4.642.4.2043" ]
  ];
  fhir:CanonicalResource.version [ fhir:value "5.0.0-ballot"];
  fhir:CanonicalResource.name [ fhir:value "MeasureDefinitionExample"];
  fhir:CanonicalResource.title [ fhir:value "MeasureDefinitionExample"];
  fhir:CanonicalResource.status [ fhir:value "draft"];
  fhir:CanonicalResource.experimental [ fhir:value "true"];
  fhir:CanonicalResource.publisher [ fhir:value "Clinical Quality Information Workgroup"];
  fhir:CanonicalResource.description [ fhir:value "Example Measure Definitions for the Measure Resource."];
  fhir:CodeSystem.url [ fhir:value "http://terminology.hl7.org/CodeSystem/measure-definition-example"];
  fhir:CodeSystem.identifier [
     fhir:Identifier.system [ fhir:value "urn:ietf:rfc:3986" ];
     fhir:Identifier.value [ fhir:value "urn:oid:2.16.840.1.113883.4.642.4.2043" ]
  ];
  fhir:CodeSystem.version [ fhir:value "5.0.0-ballot"];
  fhir:CodeSystem.name [ fhir:value "MeasureDefinitionExample"];
  fhir:CodeSystem.title [ fhir:value "MeasureDefinitionExample"];
  fhir:CodeSystem.status [ fhir:value "draft"];
  fhir:CodeSystem.experimental [ fhir:value "true"];
  fhir:CodeSystem.publisher [ fhir:value "Clinical Quality Information Workgroup"];
  fhir:CodeSystem.description [ fhir:value "Example Measure Definitions for the Measure Resource."];
  fhir:CodeSystem.caseSensitive [ fhir:value "true"];
  fhir:CodeSystem.valueSet [ fhir:value "http://hl7.org/fhir/ValueSet/measure-definition-example"];
  fhir:CodeSystem.content [ fhir:value "complete"];
  fhir:CodeSystem.concept [
     fhir:ConceptDefinitionComponent.code [ fhir:value "screening" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Screening" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "Completion of a clinical or diagnostic tool used to identify people at risk of developing or having a certain disease or condition, even in the absence of symptoms." ]
  ], [
     fhir:ConceptDefinitionComponent.code [ fhir:value "standardized-depression-screening-tool" ];
     fhir:ConceptDefinitionComponent.display [ fhir:value "Standardized Depression Screening Tool" ];
     fhir:ConceptDefinitionComponent.definition [ fhir:value "A normalized and validated depression screening tool developed for the patient population in which it is being utilized." ]
  ] .

# -------------------------------------------------------------------------------------


[ a fhir:;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root


  # from 
  # from 
  fhir:
  fhir:
  fhir:
]
Changes from both R4 and R4B This resource did not exist in Release R4 See the Full Difference for further information This analysis is available for R4 as XML or JSON and for R4B as XML or JSON .

Structure Name Flags Card. Type Description & Constraints FormularyItem TU DomainResource Definition of a FormularyItem Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension identifier Σ 0..* Identifier Business identifier for this formulary item code Σ 0..1 CodeableConcept Codes that identify this formulary item Binding: SNOMED CT Medication Codes ( Example ) status ?! Σ 0..1 code active | entered-in-error | inactive Binding: FormularyItem Status Codes ( Required ) Documentation for this format See the Extensions for this resource UML Diagram ( Legend ) FormularyItem ( DomainResource ) Business identifier for this formulary item identifier : Identifier [0..*] A code (or set of codes) that specify the product or service Usage note: every effort has been made to ensure that is identified by this formulary item code : CodeableConcept [0..1] « null (Strength=Example) SNOMEDCTMedicationCodes ?? » The validity about the information of the formulary item examples are correct and useful, but they are not a normative part of the underlying product or service itself (this element modifies the meaning of other elements) status : code [0..1] « null (Strength=Required) FormularyItemStatusCodes ! » XML Template < <!-- from --> <!-- from --> <</identifier> <</code> < </FormularyItem> JSON Template { "resourceType" : "", // from // from " " " } Turtle Template @prefix fhir: <http://hl7.org/fhir/> . [ a fhir:; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from # from fhir: fhir: fhir: ] Changes from both R4 and R4B This resource did not exist in Release R4 See the Full Difference for further information This analysis is available for R4 as XML or JSON and for R4B as XML or JSON . specification.

  Additional definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see the extensions , the spreadsheet version & the dependency analysis 11.11.3.1 Terminology Bindings Path ValueSet Type Documentation FormularyItem.code SNOMEDCTMedicationCodes Example This value set includes all drug or medicament substance codes and all pharmaceutical/biologic products from SNOMED CT - provided as an exemplar value set. FormularyItem.status FormularyItemStatusCodes Required FormularyItem Status Codes 11.11.4 Search Parameters Search parameters for this resource. See also the full list of search parameters for this resource , and check the Extensions registry for search parameters on extensions related to this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services. Name Type Description Expression In Common code token Returns formulary items for a specific code FormularyItem.code identifier token Returns formulary items with this external identifier FormularyItem.identifier