Generated Narrative: StructureDefinition FormularyItem Last updated: 2021-01-02 08:58:31+1100 Name Flags Card. Type Description & Constraints FormularyItem 0..* DomainResource Definition of a FormularyItem Elements defined in Ancestors:id, meta, implicitRules, language, <a href="http://hl7.org/fhir/R5/domainresource.html" title="A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.">text, contained, <a href="http://hl7.org/fhir/R5/domainresource.html" title="May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.">extension, <a href="http://hl7.org/fhir/R5/domainresource.html" title="May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.#xA;#xA;Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).">modifierExtension #xD; identifier Σ 0..* Identifier Business identifier for this formulary item #xD; status ?!Σ 1..1 code active | entered-in-error | inactive Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use. #xD; category 0..* CodeableConcept Categorization of this formulary item #xD; context Σ 0..1 CodeableReference(Organization | InsurancePlan) Owner of the formulary that this item was created for #xD; subject Σ 1..1 CodeableReference(PackagedProductDefinition | MedicinalProductDefinition | Medication | NutritionProduct | DeviceDefinition | ObservationDefinition | ActivityDefinition) Information that this item is about #xD; author 0..1 ContactDetail Creator or owner of the information about the item #xD; cost 0..* BackboneElement The pricing of the underlying item #xD; effectiveDate 0..* Period The date range for which the cost is effective #xD; type 1..1 CodeableConcept The category of the cost information #xD; source 0..1 string The source or owner for the price information #xD; cost[x] 1..1 The price or category of the cost of the medication Binding: MedicationCostCategoryCodes (example): A coded concept defining the category of a medication. #xD; costMoney Money #xD; costCodeableConcept CodeableConcept #xD; specialPrecaution 0..* CodeableConcept Any precautions that affect the item #xD; monitoringProgram Σ 0..* BackboneElement Program under which a item is reviewed #xD; type 0..1 CodeableConcept Type of program under which the item is monitored #xD; name 0..1 string Name of the reviewing program #xD; indicationGuideline 0..* BackboneElement Guidelines or protocols for administration of the medication for an indication #xD; indication 0..* CodeableReference(ClinicalUseDefinition) Indication for use that applies to the specific administration guideline #xD; dosingGuideline 0..* BackboneElement Guidelines for dosage of the medication #xD; treatmentIntent 0..1 CodeableConcept Intention of the treatment #xD; dosage 0..* BackboneElement Dosage for the medication for the specific guidelines #xD; type 1..1 CodeableConcept Category of dosage for a medication #xD; dosage 1..* Dosage Dosage for the medication for the specific guidelines #xD; administrationTreatment 0..1 CodeableConcept Type of treatment the guideline applies to #xD; patientCharacteristic 0..* BackboneElement Characteristics of the patient that are relevant to the administration guidelines #xD; type 1..1 CodeableConcept Categorization of specific characteristic that is relevant to the administration guideline #xD; value[x] 0..1 The specific characteristic #xD; valueCodeableConcept CodeableConcept #xD; valueQuantity Quantity #xD; valueRange Range #xD; associatedDocuments 0..* Reference(DocumentReference) Documents that provide more information about the item #xD; characteristic 0..* BackboneElement Specifies descriptive properties of the item #xD; type 1..1 CodeableConcept Code specifying the type of characteristic of item #xD; value[x] 1..1 Description of the characteristic #xD; valueCodeableConcept CodeableConcept #xD; valueString string #xD; valueQuantity Quantity(SimpleQuantity) #xD; valueBase64Binary base64Binary #xD; valueAttachment Attachment #xD; availabilityStatus 0..1 code active | entered-in-error | inactive Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use. #xD; availabilityPeriod 0..1 Period Time period of the availability of the item #xD; coverageInformation 0..* BackboneElement Specific coverage information about the item #xD; type 1..1 CodeableConcept Code specifying the type of coverage information #xD; coverage 1..1 Reference(Coverage) Description of the coverage #xD; substitution 0..* BackboneElement Specifies if changes are allowed when dispensing a medication from a regulatory perspective #xD; type 1..1 CodeableConcept Specifies the type of substitution allowed #xD; allowed 1..1 boolean Specifies if regulation allows for changes in the medication when dispensing #xD; schedule 0..* CodeableConcept Specifies the schedule of a medication in jurisdiction #xD; maxDispense 0..1 BackboneElement The maximum number of units of the medication that can be dispensed in a period #xD; quantity 1..1 SimpleQuantity The maximum number of units of the medication that can be dispensed #xD; period 0..1 Duration The period that applies to the maximum number of units #xD; associatedItems 0..* BackboneElement Associated or related formulary items #xD; type 1..1 CodeableConcept Category of formulary item #xD; reference 1..1 Reference(Formulary Item) Associated items about the formulary item #xD; Documentation for this format
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.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()
If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
Entity. Role, or Act,Entity, Role, or Act
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an [additional resource](http://build.fhir.org/resource.html#additional).
Extensions are always sliced by (at least) url
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://build.fhir.org/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Business identifier for this formulary item
Business identifier for this formulary item.
The validity about the information of the formulary item and not of the underlying product or service itself.
This status is intended to identify if the formulary item in a local system is in active use within the formulary. For example, a formulary might include a medicinal product and the status relates to its inclusion. At some point in the future, if the status of the formulary item is changed to "inactive" that means that it is no longer valid in the formulary. But the product itself might still be in active use and might be included in other formularies.
This element changes the interpretation of all descriptive attributes.
A coded concept defining if the medication is in active use.
Owner of the formulary that this item was created for
The owner of the formulary that this item was created for.
The information that this item is about.
Creator or owner of the information about the item
The creator or owner of the information about the item.
All FHIR elements must have a @value or children or both
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
The date range for which the cost is effective
The date range for which the cost information of the medication is effective.
The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.
The source or owner for the price information
The source or owner that assigns the price to the medication.
The price or category of the cost of the medication
The price or representation of the cost (for example, Band A, Band B or $, $$) of the item.
A coded concept defining the category of a medication.
The program under which the item is reviewed.
Type of program under which the item is monitored
Type of program under which the item is monitored.
Guidelines or protocols for administration of the medication for an indication
Guidelines or protocols that are applicable for the administration of the medication based on indication.
Indication for use that applies to the specific administration guideline
Indication or reason for use of the medication that applies to the specific administration guideline.
The guidelines for the dosage of the medication for the indication.
The overall intention of the treatment, for example, prophylactic, supporative, curative, etc.
Dosage for the medication for the specific guidelines
Dosage for the medication for the specific guidelines.
The type or category of dosage for a given medication (for example, prophylaxis, maintenance, therapeutic, etc.).
Type of treatment the guideline applies to
The type of the treatment that the guideline applies to, for example, long term therapy, first line treatment, etc.
Characteristics of the patient that are relevant to the administration guidelines
Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).
Categorization of specific characteristic that is relevant to the administration guideline
The categorization of the specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).
The specific characteristic (e.g. height, weight, gender, etc.).
Documents that provide more information about the item
Documents that provide more information about the item.
Specifies descriptive properties of the item
Specifies descriptive properties of the item, such as color, shape, imprints, etc.
Code specifying the type of characteristic of item
A code specifying which characteristic of the item is being described (for example, colour, shape, imprint).
The description should be provided as a CodeableConcept, SimpleQuantity or an image. The description can be a string only when these others are not available.
Time period of the availability of the item
Time period of the availability of the item.
Specific coverage information about the item
Specific coverage information about the item.
Code specifying the type of coverage information
A code specifying the type of coverage information.
Specifies if changes are allowed when dispensing a medication from a regulatory perspective
Specifies if changes are allowed when dispensing a medication from a regulatory perspective.
Specifies the type of substitution allowed
Specifies the type of substitution allowed.
Specifies if regulation allows for changes in the medication when dispensing
Specifies if regulation allows for changes in the medication when dispensing.
Specifies the schedule of a medication in jurisdiction
Specifies the schedule of a medication in jurisdiction.
The maximum number of units of the medication that can be dispensed in a period
The maximum number of units of the medication that can be dispensed in a period.
The maximum number of units of the medication that can be dispensed
The maximum number of units of the medication that can be dispensed.
The period that applies to the maximum number of units
The period that applies to the maximum number of units.
Associated or related items. For example, if the item is about a branded product (e.g. Crestor), this could link to the generic medication (e.g. Rosuvastatin).
The category of the associated formulary item reference.
Associated items about the formulary item
Associated items about the formulary item.