FHIR IG analytics| Package | hl7.fhir.uv.phx-incubator |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-FormularyItem.json |
| FHIR Version | R6 |
| Source | https://build.fhir.org/ig/HL7/phx-incubator/StructureDefinition-FormularyItem.html |
| URL | http://hl7.org/fhir/StructureDefinition/FormularyItem |
| Version | 0.1.0 |
| Status | active |
| Date | 2021-01-02T08:58:31+11:00 |
| Name | FormularyItem |
| Title | Formulary Item |
| Realm | uv |
| Authority | hl7 |
| Description | 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. |
| Type | FormularyItem |
| Kind | resource |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
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, text, contained, extension, modifierExtension | |
  identifier | Σ | 0..* | Identifier | Business identifier for this formulary item |
 status | ?!Σ | 1..1 | code | active | entered-in-error | inactive Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use. |
| category | 0..* | CodeableConcept | Categorization of this formulary item | |
 context | Σ | 0..1 | CodeableReference(Organization | InsurancePlan) | Owner of the formulary that this item was created for |
| subject | Σ | 1..1 | CodeableReference(PackagedProductDefinition | MedicinalProductDefinition | Medication | NutritionProduct | DeviceDefinition | ObservationDefinition | ActivityDefinition) | Information that this item is about |
| author | 0..1 | ContactDetail | Creator or owner of the information about the item | |
| cost | 0..* | BackboneElement | The pricing of the underlying item | |
 effectiveDate | 0..* | Period | The date range for which the cost is effective | |
| type | 1..1 | CodeableConcept | The category of the cost information | |
| source | 0..1 | string | The source or owner for the price information | |
  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. | ||
 costMoney | Money | |||
| costCodeableConcept | CodeableConcept | |||
| specialPrecaution | 0..* | CodeableConcept | Any precautions that affect the item | |
| monitoringProgram | Σ | 0..* | BackboneElement | Program under which a item is reviewed |
| type | 0..1 | CodeableConcept | Type of program under which the item is monitored | |
| name | 0..1 | string | Name of the reviewing program | |
| indicationGuideline | 0..* | BackboneElement | Guidelines or protocols for administration of the medication for an indication | |
| indication | 0..* | CodeableReference(ClinicalUseDefinition) | Indication for use that applies to the specific administration guideline | |
| dosingGuideline | 0..* | BackboneElement | Guidelines for dosage of the medication | |
| treatmentIntent | 0..1 | CodeableConcept | Intention of the treatment | |
| dosage | 0..* | BackboneElement | Dosage for the medication for the specific guidelines | |
| type | 1..1 | CodeableConcept | Category of dosage for a medication | |
| dosage | 1..* | Dosage | Dosage for the medication for the specific guidelines | |
| administrationTreatment | 0..1 | CodeableConcept | Type of treatment the guideline applies to | |
| patientCharacteristic | 0..* | BackboneElement | Characteristics of the patient that are relevant to the administration guidelines | |
| type | 1..1 | CodeableConcept | Categorization of specific characteristic that is relevant to the administration guideline | |
| value[x] | 0..1 | The specific characteristic | ||
| valueCodeableConcept | CodeableConcept | |||
| valueQuantity | Quantity | |||
| valueRange | Range | |||
| associatedDocuments | 0..* | Reference(DocumentReference) | Documents that provide more information about the item | |
| characteristic | 0..* | BackboneElement | Specifies descriptive properties of the item | |
| type | 1..1 | CodeableConcept | Code specifying the type of characteristic of item | |
| value[x] | 1..1 | Description of the characteristic | ||
| valueCodeableConcept | CodeableConcept | |||
| valueString | string | |||
| valueQuantity | Quantity(SimpleQuantity) | |||
| valueBase64Binary | base64Binary | |||
| valueAttachment | Attachment | |||
| availabilityStatus | 0..1 | code | active | entered-in-error | inactive Binding: FormularyItemStatusCodes (required): A coded concept defining if the medication is in active use. | |
| availabilityPeriod | 0..1 | Period | Time period of the availability of the item | |
| coverageInformation | 0..* | BackboneElement | Specific coverage information about the item | |
| type | 1..1 | CodeableConcept | Code specifying the type of coverage information | |
| coverage | 1..1 | Reference(Coverage) | Description of the coverage | |
| substitution | 0..* | BackboneElement | Specifies if changes are allowed when dispensing a medication from a regulatory perspective | |
| type | 1..1 | CodeableConcept | Specifies the type of substitution allowed | |
| allowed | 1..1 | boolean | Specifies if regulation allows for changes in the medication when dispensing | |
| schedule | 0..* | CodeableConcept | Specifies the schedule of a medication in jurisdiction | |
| maxDispense | 0..1 | BackboneElement | The maximum number of units of the medication that can be dispensed in a period | |
| quantity | 1..1 | SimpleQuantity | The maximum number of units of the medication that can be dispensed | |
| period | 0..1 | Duration | The period that applies to the maximum number of units | |
| associatedItems | 0..* | BackboneElement | Associated or related formulary items | |
| type | 1..1 | CodeableConcept | Category of formulary item | |
| reference | 1..1 | Reference(Formulary Item) | Associated items about the formulary item | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "FormularyItem",
"meta": {
"lastUpdated": "2021-01-02T08:58:31.578+11:00"
},
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Clinical.Medications"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "business"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "phx"
},
{
"url": "http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status",
"valueCode": ".status = entered-in-error"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/additional-resource",
"valueBoolean": true
}
],
"url": "http://hl7.org/fhir/StructureDefinition/FormularyItem",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:oid:2.16.840.1.113883.4.642.5.1118"
}
],
"version": "0.1.0",
"name": "FormularyItem",
"title": "Formulary Item",
"status": "active",
"date": "2021-01-02T08:58:31+11:00",
"publisher": "HL7 International / Pharmacy",
"contact": [
{
"name": "HL7 International / Pharmacy",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/medication"
}
]
}
],
"description": "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.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "6.0.0-ballot3",
"mapping": [
{
"identity": "w5",
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 V2 Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "FormularyItem",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "6.0.0-ballot3"
}
],
"element": [
{
"id": "FormularyItem",
"extension": [
{
"url": "http://hl7.org/fhir/build/StructureDefinition/svg",
"valueCode": "0,0"
}
],
"path": "FormularyItem",
"short": "Definition of a FormularyItem",
"definition": "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.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "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",
"expression": "contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty()",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-5",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a security label",
"expression": "contained.meta.security.empty()",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice",
"valueBoolean": true
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bestpractice-explanation",
"valueMarkdown": "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."
}
],
"key": "dom-6",
"severity": "warning",
"human": "A resource should have narrative for robust management",
"expression": "text.`div`.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "w5",
"map": "administrative.medication"
},
{
"identity": "rim",
"map": "Entity. Role, or Act,Entity, Role, or Act"
}
]
},
{
"id": "FormularyItem.id",
"path": "FormularyItem.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "FormularyItem.meta",
"path": "FormularyItem.meta",
"short": "Metadata about the resource",
"definition": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": true
},
{
"id": "FormularyItem.implicitRules",
"path": "FormularyItem.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "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.",
"comment": "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.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": true,
"isModifierReason": "This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation",
"isSummary": true
},
{
"id": "FormularyItem.language",
"path": "FormularyItem.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "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).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "required",
"description": "IETF language tag for a human language",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3",
"additional": [
{
"purpose": "starter",
"valueSet": "http://hl7.org/fhir/ValueSet/languages|6.0.0-ballot3"
}
]
}
},
{
"id": "FormularyItem.text",
"path": "FormularyItem.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "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.",
"comment": "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.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-6"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "FormularyItem.contained",
"path": "FormularyItem.contained",
"short": "Contained, inline Resources",
"definition": "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.",
"comment": "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).",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"condition": [
"dom-2",
"dom-4",
"dom-3",
"dom-5"
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FormularyItem.extension",
"path": "FormularyItem.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FormularyItem.modifierExtension",
"path": "FormularyItem.modifierExtension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Extensions that cannot be ignored",
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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).",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"mustSupport": false,
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FormularyItem.identifier",
"path": "FormularyItem.identifier",
"short": "Business identifier for this formulary item",
"definition": "Business identifier for this formulary item.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"id": "FormularyItem.status",
"path": "FormularyItem.status",
"short": "active | entered-in-error | inactive",
"definition": "The validity about the information of the formulary item and not of the underlying product or service itself.",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isModifierReason": "This element changes the interpretation of all descriptive attributes.",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FormularyItemStatus"
}
],
"strength": "required",
"description": "A coded concept defining if the medication is in active use.",
"valueSet": "http://hl7.org/fhir/ValueSet/formularyitem-status"
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"id": "FormularyItem.category",
"path": "FormularyItem.category",
"short": "Categorization of this formulary item",
"definition": "Categorization for this formulary item.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.category",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.context",
"path": "FormularyItem.context",
"short": "Owner of the formulary that this item was created for",
"definition": "The owner of the formulary that this item was created for.",
"min": 0,
"max": "1",
"base": {
"path": "FormularyItem.context",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableReference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/InsurancePlan"
]
}
],
"isSummary": true
},
{
"id": "FormularyItem.subject",
"path": "FormularyItem.subject",
"short": "Information that this item is about",
"definition": "The information that this item is about.",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.subject",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableReference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/PackagedProductDefinition",
"http://hl7.org/fhir/StructureDefinition/MedicinalProductDefinition",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/NutritionProduct",
"http://hl7.org/fhir/StructureDefinition/DeviceDefinition",
"http://hl7.org/fhir/StructureDefinition/ObservationDefinition",
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition"
]
}
],
"isSummary": true
},
{
"id": "FormularyItem.author",
"path": "FormularyItem.author",
"short": "Creator or owner of the information about the item",
"definition": "The creator or owner of the information about the item.",
"min": 0,
"max": "1",
"base": {
"path": "FormularyItem.author",
"min": 0,
"max": "1"
},
"type": [
{
"code": "ContactDetail"
}
],
"mapping": [
{
"identity": "w5",
"map": "FiveWs.actor"
},
{
"identity": "rim",
"map": "ManufacturedProduct.subjectOf.DocumentEvent.author"
}
]
},
{
"id": "FormularyItem.cost",
"path": "FormularyItem.cost",
"short": "The pricing of the underlying item",
"definition": "The price of the underlying item.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.cost",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children or both",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "FormularyItem.cost.id",
"path": "FormularyItem.cost.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.cost.extension",
"path": "FormularyItem.cost.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.cost.modifierExtension",
"path": "FormularyItem.cost.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FormularyItem.cost.effectiveDate",
"path": "FormularyItem.cost.effectiveDate",
"short": "The date range for which the cost is effective",
"definition": "The date range for which the cost information of the medication is effective.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.cost.effectiveDate",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Period"
}
]
},
{
"id": "FormularyItem.cost.type",
"path": "FormularyItem.cost.type",
"short": "The category of the cost information",
"definition": "The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.cost.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.cost.source",
"path": "FormularyItem.cost.source",
"short": "The source or owner for the price information",
"definition": "The source or owner that assigns the price to the medication.",
"min": 0,
"max": "1",
"base": {
"path": "FormularyItem.cost.source",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "FormularyItem.cost.cost[x]",
"path": "FormularyItem.cost.cost[x]",
"short": "The price or category of the cost of the medication",
"definition": "The price or representation of the cost (for example, Band A, Band B or $, $) of the item.",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.cost.cost[x]",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Money"
},
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationCostCategory"
}
],
"strength": "example",
"description": "A coded concept defining the category of a medication.",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-cost-category"
}
},
{
"id": "FormularyItem.specialPrecaution",
"path": "FormularyItem.specialPrecaution",
"short": "Any precautions that affect the item",
"definition": "Any precautions that affect the item.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.specialPrecaution",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.monitoringProgram",
"path": "FormularyItem.monitoringProgram",
"short": "Program under which a item is reviewed",
"definition": "The program under which the item is reviewed.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.monitoringProgram",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children or both",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isSummary": true
},
{
"id": "FormularyItem.monitoringProgram.id",
"path": "FormularyItem.monitoringProgram.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.monitoringProgram.extension",
"path": "FormularyItem.monitoringProgram.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.monitoringProgram.modifierExtension",
"path": "FormularyItem.monitoringProgram.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FormularyItem.monitoringProgram.type",
"path": "FormularyItem.monitoringProgram.type",
"short": "Type of program under which the item is monitored",
"definition": "Type of program under which the item is monitored.",
"min": 0,
"max": "1",
"base": {
"path": "FormularyItem.monitoringProgram.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.monitoringProgram.name",
"path": "FormularyItem.monitoringProgram.name",
"short": "Name of the reviewing program",
"definition": "Name of the reviewing program.",
"min": 0,
"max": "1",
"base": {
"path": "FormularyItem.monitoringProgram.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "FormularyItem.indicationGuideline",
"path": "FormularyItem.indicationGuideline",
"short": "Guidelines or protocols for administration of the medication for an indication",
"definition": "Guidelines or protocols that are applicable for the administration of the medication based on indication.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.indicationGuideline",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children or both",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "FormularyItem.indicationGuideline.id",
"path": "FormularyItem.indicationGuideline.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.indicationGuideline.extension",
"path": "FormularyItem.indicationGuideline.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.indicationGuideline.modifierExtension",
"path": "FormularyItem.indicationGuideline.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FormularyItem.indicationGuideline.indication",
"path": "FormularyItem.indicationGuideline.indication",
"short": "Indication for use that applies to the specific administration guideline",
"definition": "Indication or reason for use of the medication that applies to the specific administration guideline.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.indicationGuideline.indication",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableReference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/ClinicalUseDefinition"
]
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline",
"path": "FormularyItem.indicationGuideline.dosingGuideline",
"short": "Guidelines for dosage of the medication",
"definition": "The guidelines for the dosage of the medication for the indication.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.indicationGuideline.dosingGuideline",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children or both",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.id",
"path": "FormularyItem.indicationGuideline.dosingGuideline.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.extension",
"path": "FormularyItem.indicationGuideline.dosingGuideline.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.modifierExtension",
"path": "FormularyItem.indicationGuideline.dosingGuideline.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.treatmentIntent",
"path": "FormularyItem.indicationGuideline.dosingGuideline.treatmentIntent",
"short": "Intention of the treatment",
"definition": "The overall intention of the treatment, for example, prophylactic, supporative, curative, etc.",
"min": 0,
"max": "1",
"base": {
"path": "FormularyItem.indicationGuideline.dosingGuideline.treatmentIntent",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.dosage",
"path": "FormularyItem.indicationGuideline.dosingGuideline.dosage",
"short": "Dosage for the medication for the specific guidelines",
"definition": "Dosage for the medication for the specific guidelines.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.indicationGuideline.dosingGuideline.dosage",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children or both",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.dosage.id",
"path": "FormularyItem.indicationGuideline.dosingGuideline.dosage.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.dosage.extension",
"path": "FormularyItem.indicationGuideline.dosingGuideline.dosage.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.dosage.modifierExtension",
"path": "FormularyItem.indicationGuideline.dosingGuideline.dosage.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.dosage.type",
"path": "FormularyItem.indicationGuideline.dosingGuideline.dosage.type",
"short": "Category of dosage for a medication",
"definition": "The type or category of dosage for a given medication (for example, prophylaxis, maintenance, therapeutic, etc.).",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.indicationGuideline.dosingGuideline.dosage.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.dosage.dosage",
"path": "FormularyItem.indicationGuideline.dosingGuideline.dosage.dosage",
"short": "Dosage for the medication for the specific guidelines",
"definition": "Dosage for the medication for the specific guidelines.",
"min": 1,
"max": "*",
"base": {
"path": "FormularyItem.indicationGuideline.dosingGuideline.dosage.dosage",
"min": 1,
"max": "*"
},
"type": [
{
"code": "Dosage"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.administrationTreatment",
"path": "FormularyItem.indicationGuideline.dosingGuideline.administrationTreatment",
"short": "Type of treatment the guideline applies to",
"definition": "The type of the treatment that the guideline applies to, for example, long term therapy, first line treatment, etc.",
"min": 0,
"max": "1",
"base": {
"path": "FormularyItem.indicationGuideline.dosingGuideline.administrationTreatment",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic",
"path": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic",
"short": "Characteristics of the patient that are relevant to the administration guidelines",
"definition": "Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children or both",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.id",
"path": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.extension",
"path": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.modifierExtension",
"path": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.type",
"path": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.type",
"short": "Categorization of specific characteristic that is relevant to the administration guideline",
"definition": "The categorization of the specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.value[x]",
"path": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.value[x]",
"short": "The specific characteristic",
"definition": "The specific characteristic (e.g. height, weight, gender, etc.).",
"min": 0,
"max": "1",
"base": {
"path": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Quantity"
},
{
"code": "Range"
}
]
},
{
"id": "FormularyItem.associatedDocuments",
"path": "FormularyItem.associatedDocuments",
"short": "Documents that provide more information about the item",
"definition": "Documents that provide more information about the item.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.associatedDocuments",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/DocumentReference"
]
}
]
},
{
"id": "FormularyItem.characteristic",
"path": "FormularyItem.characteristic",
"short": "Specifies descriptive properties of the item",
"definition": "Specifies descriptive properties of the item, such as color, shape, imprints, etc.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.characteristic",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children or both",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "FormularyItem.characteristic.id",
"path": "FormularyItem.characteristic.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.characteristic.extension",
"path": "FormularyItem.characteristic.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.characteristic.modifierExtension",
"path": "FormularyItem.characteristic.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FormularyItem.characteristic.type",
"path": "FormularyItem.characteristic.type",
"short": "Code specifying the type of characteristic of item",
"definition": "A code specifying which characteristic of the item is being described (for example, colour, shape, imprint).",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.characteristic.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.characteristic.value[x]",
"path": "FormularyItem.characteristic.value[x]",
"short": "Description of the characteristic",
"definition": "Description of the characteristic.",
"comment": "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.",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.characteristic.value[x]",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
},
{
"code": "string"
},
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
},
{
"code": "base64Binary"
},
{
"code": "Attachment"
}
]
},
{
"id": "FormularyItem.availabilityStatus",
"path": "FormularyItem.availabilityStatus",
"short": "active | entered-in-error | inactive",
"definition": "Status of the availability of the item.",
"min": 0,
"max": "1",
"base": {
"path": "FormularyItem.availabilityStatus",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FormularyItemStatus"
}
],
"strength": "required",
"description": "A coded concept defining if the medication is in active use.",
"valueSet": "http://hl7.org/fhir/ValueSet/formularyitem-status"
}
},
{
"id": "FormularyItem.availabilityPeriod",
"path": "FormularyItem.availabilityPeriod",
"short": "Time period of the availability of the item",
"definition": "Time period of the availability of the item.",
"min": 0,
"max": "1",
"base": {
"path": "FormularyItem.availabilityPeriod",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
]
},
{
"id": "FormularyItem.coverageInformation",
"path": "FormularyItem.coverageInformation",
"short": "Specific coverage information about the item",
"definition": "Specific coverage information about the item.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.coverageInformation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children or both",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "FormularyItem.coverageInformation.id",
"path": "FormularyItem.coverageInformation.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.coverageInformation.extension",
"path": "FormularyItem.coverageInformation.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.coverageInformation.modifierExtension",
"path": "FormularyItem.coverageInformation.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FormularyItem.coverageInformation.type",
"path": "FormularyItem.coverageInformation.type",
"short": "Code specifying the type of coverage information",
"definition": "A code specifying the type of coverage information.",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.coverageInformation.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.coverageInformation.coverage",
"path": "FormularyItem.coverageInformation.coverage",
"short": "Description of the coverage",
"definition": "Description of the coverage.",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.coverageInformation.coverage",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Coverage"
]
}
]
},
{
"id": "FormularyItem.substitution",
"path": "FormularyItem.substitution",
"short": "Specifies if changes are allowed when dispensing a medication from a regulatory perspective",
"definition": "Specifies if changes are allowed when dispensing a medication from a regulatory perspective.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.substitution",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children or both",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "FormularyItem.substitution.id",
"path": "FormularyItem.substitution.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.substitution.extension",
"path": "FormularyItem.substitution.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.substitution.modifierExtension",
"path": "FormularyItem.substitution.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FormularyItem.substitution.type",
"path": "FormularyItem.substitution.type",
"short": "Specifies the type of substitution allowed",
"definition": "Specifies the type of substitution allowed.",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.substitution.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.substitution.allowed",
"path": "FormularyItem.substitution.allowed",
"short": "Specifies if regulation allows for changes in the medication when dispensing",
"definition": "Specifies if regulation allows for changes in the medication when dispensing.",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.substitution.allowed",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "FormularyItem.schedule",
"path": "FormularyItem.schedule",
"short": "Specifies the schedule of a medication in jurisdiction",
"definition": "Specifies the schedule of a medication in jurisdiction.",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.schedule",
"min": 0,
"max": "*"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.maxDispense",
"path": "FormularyItem.maxDispense",
"short": "The maximum number of units of the medication that can be dispensed in a period",
"definition": "The maximum number of units of the medication that can be dispensed in a period.",
"min": 0,
"max": "1",
"base": {
"path": "FormularyItem.maxDispense",
"min": 0,
"max": "1"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children or both",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "FormularyItem.maxDispense.id",
"path": "FormularyItem.maxDispense.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.maxDispense.extension",
"path": "FormularyItem.maxDispense.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.maxDispense.modifierExtension",
"path": "FormularyItem.maxDispense.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FormularyItem.maxDispense.quantity",
"path": "FormularyItem.maxDispense.quantity",
"short": "The maximum number of units of the medication that can be dispensed",
"definition": "The maximum number of units of the medication that can be dispensed.",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.maxDispense.quantity",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
]
},
{
"id": "FormularyItem.maxDispense.period",
"path": "FormularyItem.maxDispense.period",
"short": "The period that applies to the maximum number of units",
"definition": "The period that applies to the maximum number of units.",
"min": 0,
"max": "1",
"base": {
"path": "FormularyItem.maxDispense.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Duration"
}
]
},
{
"id": "FormularyItem.associatedItems",
"path": "FormularyItem.associatedItems",
"short": "Associated or related formulary items",
"definition": "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).",
"min": 0,
"max": "*",
"base": {
"path": "FormularyItem.associatedItems",
"min": 0,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children or both",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "FormularyItem.associatedItems.id",
"path": "FormularyItem.associatedItems.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.associatedItems.extension",
"path": "FormularyItem.associatedItems.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "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.",
"comment": "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.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "FormularyItem.associatedItems.modifierExtension",
"path": "FormularyItem.associatedItems.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "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.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "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.",
"requirements": "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).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "FormularyItem.associatedItems.type",
"path": "FormularyItem.associatedItems.type",
"short": "Category of formulary item",
"definition": "The category of the associated formulary item reference.",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.associatedItems.type",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.associatedItems.reference",
"path": "FormularyItem.associatedItems.reference",
"short": "Associated items about the formulary item",
"definition": "Associated items about the formulary item.",
"min": 1,
"max": "1",
"base": {
"path": "FormularyItem.associatedItems.reference",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/FormularyItem"
]
}
]
}
]
},
"differential": {
"element": [
{
"id": "FormularyItem",
"extension": [
{
"url": "http://hl7.org/fhir/build/StructureDefinition/svg",
"valueCode": "0,0"
}
],
"path": "FormularyItem",
"short": "Definition of a FormularyItem",
"definition": "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.",
"min": 0,
"max": "*",
"mapping": [
{
"identity": "w5",
"map": "administrative.medication"
}
]
},
{
"id": "FormularyItem.identifier",
"path": "FormularyItem.identifier",
"short": "Business identifier for this formulary item",
"definition": "Business identifier for this formulary item.",
"min": 0,
"max": "*",
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "w5",
"map": "FiveWs.identifier"
},
{
"identity": "rim",
"map": ".id"
}
]
},
{
"id": "FormularyItem.status",
"path": "FormularyItem.status",
"short": "active | entered-in-error | inactive",
"definition": "The validity about the information of the formulary item and not of the underlying product or service itself.",
"comment": "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.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isModifierReason": "This element changes the interpretation of all descriptive attributes.",
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FormularyItemStatus"
}
],
"strength": "required",
"description": "A coded concept defining if the medication is in active use.",
"valueSet": "http://hl7.org/fhir/ValueSet/formularyitem-status"
},
"mapping": [
{
"identity": "rim",
"map": ".statusCode"
}
]
},
{
"id": "FormularyItem.category",
"path": "FormularyItem.category",
"short": "Categorization of this formulary item",
"definition": "Categorization for this formulary item.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.context",
"path": "FormularyItem.context",
"short": "Owner of the formulary that this item was created for",
"definition": "The owner of the formulary that this item was created for.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableReference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Organization",
"http://hl7.org/fhir/StructureDefinition/InsurancePlan"
]
}
],
"isSummary": true
},
{
"id": "FormularyItem.subject",
"path": "FormularyItem.subject",
"short": "Information that this item is about",
"definition": "The information that this item is about.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableReference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/PackagedProductDefinition",
"http://hl7.org/fhir/StructureDefinition/MedicinalProductDefinition",
"http://hl7.org/fhir/StructureDefinition/Medication",
"http://hl7.org/fhir/StructureDefinition/NutritionProduct",
"http://hl7.org/fhir/StructureDefinition/DeviceDefinition",
"http://hl7.org/fhir/StructureDefinition/ObservationDefinition",
"http://hl7.org/fhir/StructureDefinition/ActivityDefinition"
]
}
],
"isSummary": true
},
{
"id": "FormularyItem.author",
"path": "FormularyItem.author",
"short": "Creator or owner of the information about the item",
"definition": "The creator or owner of the information about the item.",
"min": 0,
"max": "1",
"type": [
{
"code": "ContactDetail"
}
],
"mapping": [
{
"identity": "w5",
"map": "FiveWs.actor"
},
{
"identity": "rim",
"map": "ManufacturedProduct.subjectOf.DocumentEvent.author"
}
]
},
{
"id": "FormularyItem.cost",
"path": "FormularyItem.cost",
"short": "The pricing of the underlying item",
"definition": "The price of the underlying item.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "FormularyItem.cost.effectiveDate",
"path": "FormularyItem.cost.effectiveDate",
"short": "The date range for which the cost is effective",
"definition": "The date range for which the cost information of the medication is effective.",
"min": 0,
"max": "*",
"type": [
{
"code": "Period"
}
]
},
{
"id": "FormularyItem.cost.type",
"path": "FormularyItem.cost.type",
"short": "The category of the cost information",
"definition": "The category of the cost information. For example, manufacturers' cost, patient cost, claim reimbursement cost, actual acquisition cost.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.cost.source",
"path": "FormularyItem.cost.source",
"short": "The source or owner for the price information",
"definition": "The source or owner that assigns the price to the medication.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "FormularyItem.cost.cost[x]",
"path": "FormularyItem.cost.cost[x]",
"short": "The price or category of the cost of the medication",
"definition": "The price or representation of the cost (for example, Band A, Band B or $, $) of the item.",
"min": 1,
"max": "1",
"type": [
{
"code": "Money"
},
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "MedicationCostCategory"
}
],
"strength": "example",
"description": "A coded concept defining the category of a medication.",
"valueSet": "http://hl7.org/fhir/ValueSet/medication-cost-category"
}
},
{
"id": "FormularyItem.specialPrecaution",
"path": "FormularyItem.specialPrecaution",
"short": "Any precautions that affect the item",
"definition": "Any precautions that affect the item.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.monitoringProgram",
"path": "FormularyItem.monitoringProgram",
"short": "Program under which a item is reviewed",
"definition": "The program under which the item is reviewed.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
],
"isSummary": true
},
{
"id": "FormularyItem.monitoringProgram.type",
"path": "FormularyItem.monitoringProgram.type",
"short": "Type of program under which the item is monitored",
"definition": "Type of program under which the item is monitored.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.monitoringProgram.name",
"path": "FormularyItem.monitoringProgram.name",
"short": "Name of the reviewing program",
"definition": "Name of the reviewing program.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "FormularyItem.indicationGuideline",
"path": "FormularyItem.indicationGuideline",
"short": "Guidelines or protocols for administration of the medication for an indication",
"definition": "Guidelines or protocols that are applicable for the administration of the medication based on indication.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "FormularyItem.indicationGuideline.indication",
"path": "FormularyItem.indicationGuideline.indication",
"short": "Indication for use that applies to the specific administration guideline",
"definition": "Indication or reason for use of the medication that applies to the specific administration guideline.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableReference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/ClinicalUseDefinition"
]
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline",
"path": "FormularyItem.indicationGuideline.dosingGuideline",
"short": "Guidelines for dosage of the medication",
"definition": "The guidelines for the dosage of the medication for the indication.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.treatmentIntent",
"path": "FormularyItem.indicationGuideline.dosingGuideline.treatmentIntent",
"short": "Intention of the treatment",
"definition": "The overall intention of the treatment, for example, prophylactic, supporative, curative, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.dosage",
"path": "FormularyItem.indicationGuideline.dosingGuideline.dosage",
"short": "Dosage for the medication for the specific guidelines",
"definition": "Dosage for the medication for the specific guidelines.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.dosage.type",
"path": "FormularyItem.indicationGuideline.dosingGuideline.dosage.type",
"short": "Category of dosage for a medication",
"definition": "The type or category of dosage for a given medication (for example, prophylaxis, maintenance, therapeutic, etc.).",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.dosage.dosage",
"path": "FormularyItem.indicationGuideline.dosingGuideline.dosage.dosage",
"short": "Dosage for the medication for the specific guidelines",
"definition": "Dosage for the medication for the specific guidelines.",
"min": 1,
"max": "*",
"type": [
{
"code": "Dosage"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.administrationTreatment",
"path": "FormularyItem.indicationGuideline.dosingGuideline.administrationTreatment",
"short": "Type of treatment the guideline applies to",
"definition": "The type of the treatment that the guideline applies to, for example, long term therapy, first line treatment, etc.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic",
"path": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic",
"short": "Characteristics of the patient that are relevant to the administration guidelines",
"definition": "Characteristics of the patient that are relevant to the administration guidelines (for example, height, weight, gender, etc.).",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.type",
"path": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.type",
"short": "Categorization of specific characteristic that is relevant to the administration guideline",
"definition": "The categorization of the specific characteristic that is relevant to the administration guideline (e.g. height, weight, gender).",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.value[x]",
"path": "FormularyItem.indicationGuideline.dosingGuideline.patientCharacteristic.value[x]",
"short": "The specific characteristic",
"definition": "The specific characteristic (e.g. height, weight, gender, etc.).",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "Quantity"
},
{
"code": "Range"
}
]
},
{
"id": "FormularyItem.associatedDocuments",
"path": "FormularyItem.associatedDocuments",
"short": "Documents that provide more information about the item",
"definition": "Documents that provide more information about the item.",
"min": 0,
"max": "*",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/DocumentReference"
]
}
]
},
{
"id": "FormularyItem.characteristic",
"path": "FormularyItem.characteristic",
"short": "Specifies descriptive properties of the item",
"definition": "Specifies descriptive properties of the item, such as color, shape, imprints, etc.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "FormularyItem.characteristic.type",
"path": "FormularyItem.characteristic.type",
"short": "Code specifying the type of characteristic of item",
"definition": "A code specifying which characteristic of the item is being described (for example, colour, shape, imprint).",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.characteristic.value[x]",
"path": "FormularyItem.characteristic.value[x]",
"short": "Description of the characteristic",
"definition": "Description of the characteristic.",
"comment": "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.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
},
{
"code": "string"
},
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
},
{
"code": "base64Binary"
},
{
"code": "Attachment"
}
]
},
{
"id": "FormularyItem.availabilityStatus",
"path": "FormularyItem.availabilityStatus",
"short": "active | entered-in-error | inactive",
"definition": "Status of the availability of the item.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FormularyItemStatus"
}
],
"strength": "required",
"description": "A coded concept defining if the medication is in active use.",
"valueSet": "http://hl7.org/fhir/ValueSet/formularyitem-status"
}
},
{
"id": "FormularyItem.availabilityPeriod",
"path": "FormularyItem.availabilityPeriod",
"short": "Time period of the availability of the item",
"definition": "Time period of the availability of the item.",
"min": 0,
"max": "1",
"type": [
{
"code": "Period"
}
]
},
{
"id": "FormularyItem.coverageInformation",
"path": "FormularyItem.coverageInformation",
"short": "Specific coverage information about the item",
"definition": "Specific coverage information about the item.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "FormularyItem.coverageInformation.type",
"path": "FormularyItem.coverageInformation.type",
"short": "Code specifying the type of coverage information",
"definition": "A code specifying the type of coverage information.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.coverageInformation.coverage",
"path": "FormularyItem.coverageInformation.coverage",
"short": "Description of the coverage",
"definition": "Description of the coverage.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Coverage"
]
}
]
},
{
"id": "FormularyItem.substitution",
"path": "FormularyItem.substitution",
"short": "Specifies if changes are allowed when dispensing a medication from a regulatory perspective",
"definition": "Specifies if changes are allowed when dispensing a medication from a regulatory perspective.",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "FormularyItem.substitution.type",
"path": "FormularyItem.substitution.type",
"short": "Specifies the type of substitution allowed",
"definition": "Specifies the type of substitution allowed.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.substitution.allowed",
"path": "FormularyItem.substitution.allowed",
"short": "Specifies if regulation allows for changes in the medication when dispensing",
"definition": "Specifies if regulation allows for changes in the medication when dispensing.",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "FormularyItem.schedule",
"path": "FormularyItem.schedule",
"short": "Specifies the schedule of a medication in jurisdiction",
"definition": "Specifies the schedule of a medication in jurisdiction.",
"min": 0,
"max": "*",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.maxDispense",
"path": "FormularyItem.maxDispense",
"short": "The maximum number of units of the medication that can be dispensed in a period",
"definition": "The maximum number of units of the medication that can be dispensed in a period.",
"min": 0,
"max": "1",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "FormularyItem.maxDispense.quantity",
"path": "FormularyItem.maxDispense.quantity",
"short": "The maximum number of units of the medication that can be dispensed",
"definition": "The maximum number of units of the medication that can be dispensed.",
"min": 1,
"max": "1",
"type": [
{
"code": "Quantity",
"profile": [
"http://hl7.org/fhir/StructureDefinition/SimpleQuantity"
]
}
]
},
{
"id": "FormularyItem.maxDispense.period",
"path": "FormularyItem.maxDispense.period",
"short": "The period that applies to the maximum number of units",
"definition": "The period that applies to the maximum number of units.",
"min": 0,
"max": "1",
"type": [
{
"code": "Duration"
}
]
},
{
"id": "FormularyItem.associatedItems",
"path": "FormularyItem.associatedItems",
"short": "Associated or related formulary items",
"definition": "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).",
"min": 0,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "FormularyItem.associatedItems.type",
"path": "FormularyItem.associatedItems.type",
"short": "Category of formulary item",
"definition": "The category of the associated formulary item reference.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
]
},
{
"id": "FormularyItem.associatedItems.reference",
"path": "FormularyItem.associatedItems.reference",
"short": "Associated items about the formulary item",
"definition": "Associated items about the formulary item.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/FormularyItem"
]
}
]
}
]
}
}