PrescribeIT® Specification and Guide Version 5.0

 

Definitions for the profile-parameters-formulary-response Profile.

1. Parameters
Definition

This special resource type is used to represent an operation request and response (operations.html). It has no other use, and there is no RESTful endpoint associated with it.

Control0..*
Must Supporttrue
Comments

The parameters that may be used are defined by the OperationDefinition resource.

Max Length0
2. Parameters.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

Max Length0
3. Parameters.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control1..1
TypeMeta
Must Supporttrue
Max Length0
4. Parameters.meta.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
5. Parameters.meta.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Max Length0
6. Parameters.meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.

Control0..1
Typeid
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

Max Length0
7. Parameters.meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control0..1
Typeinstant
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.

Max Length0
8. Parameters.meta.profile
Definition

A list of profiles StructureDefinitions that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control1..*
Typeuri
Must Supporttrue
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Max Length0
SlicingThis element introduces a set of slices on Parameters.meta.profile. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ value
9. Parameters.meta.profile:profile
SliceNameprofile
Definition

A list of profiles StructureDefinitions that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control1..1
Typeuri
Must Supporttrue
Comments

Fixed value: http://prescribeit.ca/fhir/StructureDefinition/profile-parameters-formulary-response

Max Length0
Fixed Valuehttp://prescribeit.ca/fhir/StructureDefinition/profile-parameters-formulary-response
10. Parameters.meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System.

TypeCoding
Comments

The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

Max Length0
11. Parameters.meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control1..*
Binding

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"

TypeCoding
Must Supporttrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Max Length0
SlicingThis element introduces a set of slices on Parameters.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
12. Parameters.meta.tag:version
SliceNameversion
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control1..1
BindingThe codes SHALL be taken from SharedSpecificationVersion (20210501)
TypeCoding
Must Supporttrue
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

Max Length0
13. Parameters.meta.tag:version.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
14. Parameters.meta.tag:version.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Max Length0
15. Parameters.meta.tag:version.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Must Supporttrue
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion

Max Length0
Fixed Valuehttps://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
16. Parameters.meta.tag:version.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Max Length0
17. Parameters.meta.tag:version.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Max Length0
18. Parameters.meta.tag:version.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Max Length0
19. Parameters.meta.tag:version.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Max Length0
20. Parameters.implicitRules
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.

Control0..1
Typeuri
Is Modifiertrue
Comments

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 as much as possible.

Max Length0
21. Parameters.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from http://tools.ietf.org/html/bcp47 A human language.

Typecode
Comments

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).

Max Length0
22. Parameters.parameter
Definition

A parameter passed to or received from the operation.

Control0..*
TypeBackboneElement
Must Supporttrue
Max Length0
InvariantsDefined on this element
inv-1: A parameter must have only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
SlicingThis element introduces a set of slices on Parameters.parameter. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • value @ name
23. Parameters.parameter.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
24. Parameters.parameter.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Max Length0
25. Parameters.parameter.modifierExtension
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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

Max Length0
26. Parameters.parameter.name
Definition

The name of the parameter (reference to the operation definition).

Control1..1
Typestring
Max Length0
27. Parameters.parameter.value[x]
Definition

If the parameter is a data type.

Control0..1 This element is affected by the following invariants: inv-1
TypeChoice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
Max Length0
28. Parameters.parameter.resource
Definition

If the parameter is a whole resource.

Control0..1 This element is affected by the following invariants: inv-1
TypeResource
Max Length0
29. Parameters.parameter.part
Definition

A named part of a parameter. In many implementation context, a set of named parts is known as a "Tuple".

Control0..*
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Comments

Only one level of Tuples is allowed.

30. Parameters.parameter:product
SliceNameproduct
Definition

A manufactured medication found in the jurisdictional formulary associated with the requested drug.

Control1..*
TypeBackboneElement
Must Supporttrue
Comments

There will be a maximum of one repetition if the search was for a manufactured product, but there may be more if the search was for a higher-level product.

These must be displayed in the order in which they are returned

Max Length0
InvariantsDefined on this element
inv-1: A parameter must have only one of (value, resource, part) (: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists())))
31. Parameters.parameter:product.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
32. Parameters.parameter:product.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Max Length0
33. Parameters.parameter:product.modifierExtension
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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

Max Length0
34. Parameters.parameter:product.name
Definition

The name of the parameter (reference to the operation definition).

Control1..1
Typestring
Must Supporttrue
Comments

Fixed value: product

Max Length0
Fixed Valueproduct
35. Parameters.parameter:product.value[x]
Definition

If the parameter is a data type.

Control0..1 This element is affected by the following invariants: inv-1
TypeChoice of: boolean, integer, decimal, base64Binary, instant, string, uri, date, dateTime, time, code, oid, id, unsignedInt, positiveInt, markdown, Annotation, Attachment, Identifier, CodeableConcept, Coding, Quantity, Range, Period, Ratio, SampledData, Signature, HumanName, Address, ContactPoint, Timing, Reference, Meta
[x] NoteSee Choice of Data Types for further information about how to use [x]
Max Length0
36. Parameters.parameter:product.resource
Definition

If the parameter is a whole resource.

Control0..1 This element is affected by the following invariants: inv-1
TypeResource
Max Length0
37. Parameters.parameter:product.part
Definition

This element will be sliced once for each property describing the product.

Control2..8
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Must Supporttrue
Comments

Only one level of Tuples is allowed.

SlicingThis element introduces a set of slices on Parameters.parameter.part. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • value @ name
38. Parameters.parameter:product.part:code
SliceNamecode
Definition

A code indicating whether the specified product is covered within the specified jurisdiction's formulary

Control1..1
TypeBackboneElement
Must Supporttrue
Comments

 

39. Parameters.parameter:product.part:code.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
40. Parameters.parameter:product.part:code.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Max Length0
41. Parameters.parameter:product.part:code.modifierExtension
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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

Max Length0
42. Parameters.parameter:product.part:code.name
Definition

The name of the parameter (reference to the operation definition).

Control1..1
Typestring
Must Supporttrue
Comments

Fixed value: code

Max Length0
Fixed Valuecode
43. Parameters.parameter:product.part:code.value[x]
Definition

If the parameter is a data type.

Control1..1 This element is affected by the following invariants: inv-1
BindingThe codes SHALL be taken from PrescriptionMedicinalProduct; other codes may be used where these codes are not suitable
TypeCoding
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Max Length0
44. Parameters.parameter:product.part:code.value[x].id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
45. Parameters.parameter:product.part:code.value[x].extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Max Length0
46. Parameters.parameter:product.part:code.value[x].system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Max Length0
47. Parameters.parameter:product.part:code.value[x].version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

Max Length0
48. Parameters.parameter:product.part:code.value[x].code
Definition

The code for the medication product.

Note: At present, the server will not populate the 'system' element - receivers will need to infer that based on the code.)

Control1..1
Typecode
Must Supporttrue
Requirements

Need to refer to a particular code in the system.

Max Length0
49. Parameters.parameter:product.part:code.value[x].display
Definition

The name of the medication product

Control1..1
Typestring
Must Supporttrue
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

Comments

Usage Rule: The drug product name will be conveyed here.

Conformance Rule: This must display the value as returned in the response which is how the name appears in the provincial formulary. If the name provided is 'Product Not Found' vendor can display this value or overwrite this value with the name of the product as selected by the prescriber.

Max Length200
50. Parameters.parameter:product.part:code.value[x].userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

Max Length0
51. Parameters.parameter:product.part:code.resource
Definition

If the parameter is a whole resource.

Control0..0 This element is affected by the following invariants: inv-1
TypeResource
Max Length0
52. Parameters.parameter:product.part:code.part
Definition

A named part of a parameter. In many implementation context, a set of named parts is known as a "Tuple".

Control0..0
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Comments

Only one level of Tuples is allowed.

53. Parameters.parameter:product.part:coverage
SliceNamecoverage
Definition

A code indicating whether the specified product is covered within the specified jurisdiction's formulary

Control1..1
TypeBackboneElement
Must Supporttrue
Comments

 

54. Parameters.parameter:product.part:coverage.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
55. Parameters.parameter:product.part:coverage.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Max Length0
56. Parameters.parameter:product.part:coverage.modifierExtension
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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

Max Length0
57. Parameters.parameter:product.part:coverage.name
Definition

The name of the parameter (reference to the operation definition).

Control1..1
Typestring
Must Supporttrue
Comments

Fixed value: coverage

Max Length0
Fixed Valuecoverage
58. Parameters.parameter:product.part:coverage.value[x]
Definition

A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text.

Control1..1
BindingThe codes SHALL be taken from PrescriptionMedicationCoverage (20220331)
TypeCodeableConcept(Shared Health CodeableConcept Code)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Comments

-

Max Length0
59. Parameters.parameter:product.part:coverage.resource
Definition

If the parameter is a whole resource.

Control0..0 This element is affected by the following invariants: inv-1
TypeResource
Max Length0
60. Parameters.parameter:product.part:coverage.part
Definition

A named part of a parameter. In many implementation context, a set of named parts is known as a "Tuple".

Control0..0
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Comments

Only one level of Tuples is allowed.

61. Parameters.parameter:product.part:costSymbol
SliceNamecostSymbol
Definition

A symbolic representation of the relative cost of a unit of the product (e.g. '$$' or '$$$$+')

Control0..1
TypeBackboneElement
Must Supporttrue
Comments

 

62. Parameters.parameter:product.part:costSymbol.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
63. Parameters.parameter:product.part:costSymbol.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Max Length0
64. Parameters.parameter:product.part:costSymbol.modifierExtension
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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

Max Length0
65. Parameters.parameter:product.part:costSymbol.name
Definition

The name of the parameter (reference to the operation definition).

Control1..1
Typestring
Must Supporttrue
Comments

Fixed value: costSymbol

Max Length0
Fixed ValuecostSymbol
66. Parameters.parameter:product.part:costSymbol.value[x]
Definition

If the parameter is a data type.

Control1..1 This element is affected by the following invariants: inv-1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Max Length9
67. Parameters.parameter:product.part:costSymbol.resource
Definition

If the parameter is a whole resource.

Control0..0 This element is affected by the following invariants: inv-1
TypeResource
Max Length0
68. Parameters.parameter:product.part:costSymbol.part
Definition

A named part of a parameter. In many implementation context, a set of named parts is known as a "Tuple".

Control0..0
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Comments

Only one level of Tuples is allowed.

69. Parameters.parameter:product.part:unitCost
SliceNameunitCost
Definition

The estimated cost of a unit of the product in dollars

Control0..1
TypeBackboneElement
Must Supporttrue
Comments

Conformance Rule: Vendors must never display to the user; it will be used to determine the cost range for the product in order to display the symbol that represents the cost range.

70. Parameters.parameter:product.part:unitCost.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
71. Parameters.parameter:product.part:unitCost.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Max Length0
72. Parameters.parameter:product.part:unitCost.modifierExtension
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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

Max Length0
73. Parameters.parameter:product.part:unitCost.name
Definition

The name of the parameter (reference to the operation definition).

Control1..1
Typestring
Must Supporttrue
Comments

Fixed value: unitCost

Max Length0
Fixed ValueunitCost
74. Parameters.parameter:product.part:unitCost.value[x]
Definition

A dollar amount expressed in Canadian funds

Control1..1
TypeQuantity(Shared Health Money)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Comments

The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator.

Max Length0
InvariantsDefined on this element
qty-3: If a code for the unit is present, the system SHALL also be present (: code.empty() or system.exists())
75. Parameters.parameter:product.part:unitCost.resource
Definition

If the parameter is a whole resource.

Control0..0 This element is affected by the following invariants: inv-1
TypeResource
Max Length0
76. Parameters.parameter:product.part:unitCost.part
Definition

A named part of a parameter. In many implementation context, a set of named parts is known as a "Tuple".

Control0..0
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Comments

Only one level of Tuples is allowed.

77. Parameters.parameter:product.part:costRange
SliceNamecostRange
Definition

A symbolic representation of the relative cost of a unit of the product (e.g. '$$' or '$$$$+')

Control0..1
TypeBackboneElement
Must Supporttrue
Comments

 

78. Parameters.parameter:product.part:costRange.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
79. Parameters.parameter:product.part:costRange.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Max Length0
80. Parameters.parameter:product.part:costRange.modifierExtension
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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

Max Length0
81. Parameters.parameter:product.part:costRange.name
Definition

The name of the parameter (reference to the operation definition).

Control1..1
Typestring
Must Supporttrue
Comments

Fixed value: costRange

Max Length0
Fixed ValuecostRange
82. Parameters.parameter:product.part:costRange.value[x]
Definition

If the parameter is a data type.

Control1..1 This element is affected by the following invariants: inv-1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Max Length20
83. Parameters.parameter:product.part:costRange.resource
Definition

If the parameter is a whole resource.

Control0..0 This element is affected by the following invariants: inv-1
TypeResource
Max Length0
84. Parameters.parameter:product.part:costRange.part
Definition

A named part of a parameter. In many implementation context, a set of named parts is known as a "Tuple".

Control0..0
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Comments

Only one level of Tuples is allowed.

85. Parameters.parameter:product.part:costUnit
SliceNamecostUnit
Definition

The quantity of the drug associated with the cost symbol and cost range (e.g. 'per mg' or 'per 28 tablet package')

Control0..1
TypeBackboneElement
Must Supporttrue
Comments

Usage Note: Vendors should allow for 75 characters though this could be extended in the future.

86. Parameters.parameter:product.part:costUnit.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
87. Parameters.parameter:product.part:costUnit.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Max Length0
88. Parameters.parameter:product.part:costUnit.modifierExtension
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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

Max Length0
89. Parameters.parameter:product.part:costUnit.name
Definition

The name of the parameter (reference to the operation definition).

Control1..1
Typestring
Must Supporttrue
Comments

Fixed value: costUnit

Max Length0
Fixed ValuecostUnit
90. Parameters.parameter:product.part:costUnit.value[x]
Definition

If the parameter is a data type.

Control1..1 This element is affected by the following invariants: inv-1
Typestring
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Max Length75
91. Parameters.parameter:product.part:costUnit.resource
Definition

If the parameter is a whole resource.

Control0..0 This element is affected by the following invariants: inv-1
TypeResource
Max Length0
92. Parameters.parameter:product.part:costUnit.part
Definition

A named part of a parameter. In many implementation context, a set of named parts is known as a "Tuple".

Control0..0
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Comments

Only one level of Tuples is allowed.

93. Parameters.parameter:product.part:manufacturedProductUrl
SliceNamemanufacturedProductUrl
Definition

A link to a web page or document where additional information can be found about the manufactured product

Control0..1
TypeBackboneElement
Must Supporttrue
Comments

 

94. Parameters.parameter:product.part:manufacturedProductUrl.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
95. Parameters.parameter:product.part:manufacturedProductUrl.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Max Length0
96. Parameters.parameter:product.part:manufacturedProductUrl.modifierExtension
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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

Max Length0
97. Parameters.parameter:product.part:manufacturedProductUrl.name
Definition

The name of the parameter (reference to the operation definition).

Control1..1
Typestring
Must Supporttrue
Comments

Fixed value: manufacturedProductUrl

Max Length0
Fixed ValuemanufacturedProductUrl
98. Parameters.parameter:product.part:manufacturedProductUrl.value[x]
Definition

If the parameter is a data type.

Control1..1 This element is affected by the following invariants: inv-1
Typeuri
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Max Length0
99. Parameters.parameter:product.part:manufacturedProductUrl.resource
Definition

If the parameter is a whole resource.

Control0..0 This element is affected by the following invariants: inv-1
TypeResource
Max Length0
100. Parameters.parameter:product.part:manufacturedProductUrl.part
Definition

A named part of a parameter. In many implementation context, a set of named parts is known as a "Tuple".

Control0..0
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Comments

Only one level of Tuples is allowed.

101. Parameters.parameter:product.part:conditionalCoverageUrl
SliceNameconditionalCoverageUrl
Definition

A link to a web page or document where additional information can be found about the formulary's conditional coverage rules

Control0..1
TypeBackboneElement
Must Supporttrue
Comments

 

102. Parameters.parameter:product.part:conditionalCoverageUrl.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Max Length0
103. Parameters.parameter:product.part:conditionalCoverageUrl.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

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.

Max Length0
104. Parameters.parameter:product.part:conditionalCoverageUrl.modifierExtension
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 that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, 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.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

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.

Max Length0
105. Parameters.parameter:product.part:conditionalCoverageUrl.name
Definition

The name of the parameter (reference to the operation definition).

Control1..1
Typestring
Must Supporttrue
Comments

Fixed value: conditionalCoverageUrl

Max Length0
Fixed ValueconditionalCoverageUrl
106. Parameters.parameter:product.part:conditionalCoverageUrl.value[x]
Definition

If the parameter is a data type.

Control1..1 This element is affected by the following invariants: inv-1
Typeuri
[x] NoteSee Choice of Data Types for further information about how to use [x]
Must Supporttrue
Max Length0
107. Parameters.parameter:product.part:conditionalCoverageUrl.resource
Definition

If the parameter is a whole resource.

Control0..0 This element is affected by the following invariants: inv-1
TypeResource
Max Length0
108. Parameters.parameter:product.part:conditionalCoverageUrl.part
Definition

A named part of a parameter. In many implementation context, a set of named parts is known as a "Tuple".

Control0..0
TypeSee ttp://hl7.org/fhir/StructureDefinition/Parameters#Parameters.parameter
Comments

Only one level of Tuples is allowed.