PrescribeIT® Formulary Operation Output

3.63 StructureDefinition: PrescribeIT® Formulary Operation Output

The official URL for this profile is:

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

3.63.2 Formal Views of Profile Content

Download Excel representation

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Parameters

Name	Card.	Type	Constraints and Usage
Parameters	0..*	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. Comments: The parameters that may be used are defined by the OperationDefinition resource.
meta	1..1	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.
profile	1..*	uri	Slice: Unordered, Open by value:value Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. 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.
profile (profile)	1..1	uri	Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/profile-parameters-formulary-response Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: Fixed value: http://prescribeit.ca/fhir/StructureDefinition/profile-parameters-formulary-response
tag	1..*	Coding	Slice: Unordered, Open by value:system Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" 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. 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.
tag (version)	1..1	Coding	Binding: SharedSpecificationVersion (20210501) (required) 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. 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.
system	1..1	uri	Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
code	1..1	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).
parameter	0..*	BackboneElement	Slice: Unordered, Closed by value:name inv-1: A parameter must have only one of (value, resource, part) Definition: A parameter passed to or received from the operation.
parameter (product)	1..*	BackboneElement	inv-1: A parameter must have only one of (value, resource, part) Definition: A manufactured medication found in the jurisdictional formulary associated with the requested drug. 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
name	1..1	string	Fixed Value: product Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: product
part	2..8	See parameter (Parameters)	See Parameters.Parameters.parameter Slice: Unordered, Closed by value:name Definition: This element will be sliced once for each property describing the product. Comments: Only one level of Tuples is allowed.
part (code)	1..1	BackboneElement	Definition: A code indicating whether the specified product is covered within the specified jurisdiction's formulary Comments:
name	1..1	string	Fixed Value: code Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: code
value[x]	1..1	Coding	Binding: PrescriptionMedicinalProduct (extensible) Definition: If the parameter is a data type.
code	1..1	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.)
display	1..1	string	Max Length: 200 Definition: The name of the medication product 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.
part (coverage)	1..1	BackboneElement	Definition: A code indicating whether the specified product is covered within the specified jurisdiction's formulary Comments:
name	1..1	string	Fixed Value: coverage Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: coverage
value[x]	1..1	Shared Health CodeableConcept Code	Binding: PrescriptionMedicationCoverage (20190430) (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments:
part (costSymbol)	0..1	BackboneElement	Definition: A symbolic representation of the relative cost of a unit of the product (e.g. '$$' or '$$$$+') Comments:
name	1..1	string	Fixed Value: costSymbol Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: costSymbol
value[x]	1..1	string	Max Length: 9 Definition: If the parameter is a data type.
part (unitCost)	0..1	BackboneElement	Definition: The estimated cost of a unit of the product in dollars 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.
name	1..1	string	Fixed Value: unitCost Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: unitCost
value[x]	1..1	Shared Health Money	qty-3: If a code for the unit is present, the system SHALL also be present Definition: A dollar amount expressed in Canadian funds 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.
part (costRange)	0..1	BackboneElement	Definition: A symbolic representation of the relative cost of a unit of the product (e.g. '$$' or '$$$$+') Comments:
name	1..1	string	Fixed Value: costRange Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: costRange
value[x]	1..1	string	Max Length: 20 Definition: If the parameter is a data type.
part (costUnit)	0..1	BackboneElement	Definition: The quantity of the drug associated with the cost symbol and cost range (e.g. 'per mg' or 'per 28 tablet package') Comments: Usage Note: Vendors should allow for 75 characters though this could be extended in the future.
name	1..1	string	Fixed Value: costUnit Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: costUnit
value[x]	1..1	string	Max Length: 75 Definition: If the parameter is a data type.
part (manufacturedProductUrl)	0..1	BackboneElement	Definition: A link to a web page or document where additional information can be found about the manufactured product Comments:
name	1..1	string	Fixed Value: manufacturedProductUrl Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: manufacturedProductUrl
value[x]	1..1	uri	Definition: If the parameter is a data type.
part (conditionalCoverageUrl)	0..1	BackboneElement	Definition: A link to a web page or document where additional information can be found about the formulary's conditional coverage rules Comments:
name	1..1	string	Fixed Value: conditionalCoverageUrl Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: conditionalCoverageUrl
value[x]	1..1	uri	Definition: If the parameter is a data type.

This structure is derived from Parameters

Summary

Mandatory: 14 elements (6 nested mandatory elements)
Must-Support: 37 elements
Fixed Value: 11 elements
Prohibited: 16 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

The element Parameters.meta.profile is sliced based on the value of value:value
The element Parameters.meta.tag is sliced based on the value of value:system
The element Parameters.parameter is sliced based on the value of value:name (Closed)
The element Parameters.parameter.part is sliced based on the value of value:name (Closed)

This structure is derived from Parameters

Name	Flags	Card.	Type	Description & Constraints
Parameters	S	0..*	Parameters	Operation Request or Response
meta	S	1..1	Meta	Metadata about the resource
profile	S	1..*	(Slice Definition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:value
profile:profile	S	1..1	uri	Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/profile-parameters-formulary-response
tag	S	1..*	(Slice Definition)	Tags applied to this resource Slice: Unordered, Open by value:system
tag:version	S	1..1	Coding	Tags applied to this resource Binding: SharedSpecificationVersion (20210501) (required)
system	S	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
code	S	1..1	code	Symbol in syntax defined by the system
parameter	S	0..*	(Slice Definition)	Operation Parameter Slice: Unordered, Closed by value:name
parameter:product	S	1..*	BackboneElement	Formulary product
name	S	1..1	string	Name from the definition Fixed Value: product
part	S	2..8	(Slice Definition)	Named part of a parameter (e.g. Tuple) Slice: Unordered, Closed by value:name
part:code	S	1..1	BackboneElement	Name and code for product
name	S	1..1	string	Name from the definition Fixed Value: code
value[x]	S	1..1	Coding	If parameter is a data type Binding: PrescriptionMedicinalProduct (extensible)
code	S	1..1	code	Product code
display	S	1..1	string	Product name Max Length: 200
resource		0..0
part		0..0
part:coverage	S	1..1	BackboneElement	Is product covered?
name	S	1..1	string	Name from the definition Fixed Value: coverage
value[x]	S	1..1	Shared Health CodeableConcept Code	Concept - reference to a terminology or just text Binding: PrescriptionMedicationCoverage (20190430) (required)
resource		0..0
part		0..0
part:costSymbol	S	0..1	BackboneElement	Symbolic cost
name	S	1..1	string	Name from the definition Fixed Value: costSymbol
value[x]	S	1..1	string	If parameter is a data type Max Length: 9
resource		0..0
part		0..0
part:unitCost	S	0..1	BackboneElement	Unit Cost
name	S	1..1	string	Name from the definition Fixed Value: unitCost
value[x]	S	1..1	Shared Health Money	Canadian money
resource		0..0
part		0..0
part:costRange	S	0..1	BackboneElement	Cost range
name	S	1..1	string	Name from the definition Fixed Value: costRange
value[x]	S	1..1	string	If parameter is a data type Max Length: 20
resource		0..0
part		0..0
part:costUnit	S	0..1	BackboneElement	Cost unit
name	S	1..1	string	Name from the definition Fixed Value: costUnit
value[x]	S	1..1	string	If parameter is a data type Max Length: 75
resource		0..0
part		0..0
part:manufacturedProductUrl	S	0..1	BackboneElement	Manufactured Product URL
name	S	1..1	string	Name from the definition Fixed Value: manufacturedProductUrl
value[x]	S	1..1	uri	If parameter is a data type
resource		0..0
part		0..0
part:conditionalCoverageUrl	S	0..1	BackboneElement	Conditional Coverage URL
name	S	1..1	string	Name from the definition Fixed Value: conditionalCoverageUrl
value[x]	S	1..1	uri	If parameter is a data type
resource		0..0
part		0..0
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Parameters	S	0..*	Parameters	Operation Request or Response
id	Σ	0..1	id	Logical id of this artifact
meta	SΣ	1..1	Meta	Metadata about the resource
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
profile	SΣ	1..*	(Slice Definition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:value
profile:profile	SΣ	1..1	uri	Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/profile-parameters-formulary-response
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	SΣ	1..*	(Slice Definition)	Tags applied to this resource Slice: Unordered, Open by value:system Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
tag:version	SΣ	1..1	Coding	Tags applied to this resource Binding: SharedSpecificationVersion (20210501) (required)
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language.
parameter	SI	0..*	(Slice Definition)	Operation Parameter Slice: Unordered, Closed by value:name
parameter:All Slices				Content/Rules for all slices
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name		1..1	string	Name from the definition
value[x]	I	0..1		If parameter is a data type
valueBoolean			boolean
valueInteger			integer
valueDecimal			decimal
valueBase64Binary			base64Binary
valueInstant			instant
valueString			string
valueUri			uri
valueDate			date
valueDateTime			dateTime
valueTime			time
valueCode			code
valueOid			oid
valueId			id
valueUnsignedInt			unsignedInt
valuePositiveInt			positiveInt
valueMarkdown			markdown
valueAnnotation			Annotation
valueAttachment			Attachment
valueIdentifier			Identifier
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueQuantity			Quantity
valueRange			Range
valuePeriod			Period
valueRatio			Ratio
valueSampledData			SampledData
valueSignature			Signature
valueHumanName			HumanName
valueAddress			Address
valueContactPoint			ContactPoint
valueTiming			Timing
valueReference			Reference(Any)
valueMeta			Meta
resource	I	0..1	Resource	If parameter is a whole resource
part		0..*	See parameter (Parameters)	Named part of a parameter (e.g. Tuple)
parameter:product	SI	1..*	BackboneElement	Formulary product
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: product
value[x]	I	0..1		If parameter is a data type
valueBoolean			boolean
valueInteger			integer
valueDecimal			decimal
valueBase64Binary			base64Binary
valueInstant			instant
valueString			string
valueUri			uri
valueDate			date
valueDateTime			dateTime
valueTime			time
valueCode			code
valueOid			oid
valueId			id
valueUnsignedInt			unsignedInt
valuePositiveInt			positiveInt
valueMarkdown			markdown
valueAnnotation			Annotation
valueAttachment			Attachment
valueIdentifier			Identifier
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueQuantity			Quantity
valueRange			Range
valuePeriod			Period
valueRatio			Ratio
valueSampledData			SampledData
valueSignature			Signature
valueHumanName			HumanName
valueAddress			Address
valueContactPoint			ContactPoint
valueTiming			Timing
valueReference			Reference(Any)
valueMeta			Meta
resource	I	0..1	Resource	If parameter is a whole resource
part	S	2..8	(Slice Definition)	Named part of a parameter (e.g. Tuple) Slice: Unordered, Closed by value:name
part:code	S	1..1	BackboneElement	Name and code for product
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: code
value[x]	SI	1..1	Coding	If parameter is a data type Binding: PrescriptionMedicinalProduct (extensible)
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	Product code
display	SΣ	1..1	string	Product name Max Length: 200
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
part:coverage	S	1..1	BackboneElement	Is product covered?
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: coverage
value[x]	S	1..1	Shared Health CodeableConcept Code	Concept - reference to a terminology or just text Binding: PrescriptionMedicationCoverage (20190430) (required)
part:costSymbol	S	0..1	BackboneElement	Symbolic cost
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: costSymbol
value[x]	SI	1..1	string	If parameter is a data type Max Length: 9
part:unitCost	S	0..1	BackboneElement	Unit Cost
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: unitCost
value[x]	SI	1..1	Shared Health Money	Canadian money
part:costRange	S	0..1	BackboneElement	Cost range
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: costRange
value[x]	SI	1..1	string	If parameter is a data type Max Length: 20
part:costUnit	S	0..1	BackboneElement	Cost unit
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: costUnit
value[x]	SI	1..1	string	If parameter is a data type Max Length: 75
part:manufacturedProductUrl	S	0..1	BackboneElement	Manufactured Product URL
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: manufacturedProductUrl
value[x]	SI	1..1	uri	If parameter is a data type
part:conditionalCoverageUrl	S	0..1	BackboneElement	Conditional Coverage URL
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: conditionalCoverageUrl
value[x]	SI	1..1	uri	If parameter is a data type
Documentation for this format

Grid View

This structure is derived from Parameters

Name	Card.	Type	Constraints and Usage
Parameters	0..*	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. Comments: The parameters that may be used are defined by the OperationDefinition resource.
meta	1..1	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.
profile	1..*	uri	Slice: Unordered, Open by value:value Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. 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.
profile (profile)	1..1	uri	Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/profile-parameters-formulary-response Definition: A list of profiles [[[StructureDefinition]]]s that this resource claims to conform to. The URL is a reference to [[[StructureDefinition.url]]]. Comments: Fixed value: http://prescribeit.ca/fhir/StructureDefinition/profile-parameters-formulary-response
tag	1..*	Coding	Slice: Unordered, Open by value:system Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" 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. 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.
tag (version)	1..1	Coding	Binding: SharedSpecificationVersion (20210501) (required) 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. 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.
system	1..1	uri	Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion Definition: The identification of the code system that defines the meaning of the symbol in the code. Comments: Fixed value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
code	1..1	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).
parameter	0..*	BackboneElement	Slice: Unordered, Closed by value:name inv-1: A parameter must have only one of (value, resource, part) Definition: A parameter passed to or received from the operation.
parameter (product)	1..*	BackboneElement	inv-1: A parameter must have only one of (value, resource, part) Definition: A manufactured medication found in the jurisdictional formulary associated with the requested drug. 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
name	1..1	string	Fixed Value: product Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: product
part	2..8	See parameter (Parameters)	See Parameters.Parameters.parameter Slice: Unordered, Closed by value:name Definition: This element will be sliced once for each property describing the product. Comments: Only one level of Tuples is allowed.
part (code)	1..1	BackboneElement	Definition: A code indicating whether the specified product is covered within the specified jurisdiction's formulary Comments:
name	1..1	string	Fixed Value: code Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: code
value[x]	1..1	Coding	Binding: PrescriptionMedicinalProduct (extensible) Definition: If the parameter is a data type.
code	1..1	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.)
display	1..1	string	Max Length: 200 Definition: The name of the medication product 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.
part (coverage)	1..1	BackboneElement	Definition: A code indicating whether the specified product is covered within the specified jurisdiction's formulary Comments:
name	1..1	string	Fixed Value: coverage Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: coverage
value[x]	1..1	Shared Health CodeableConcept Code	Binding: PrescriptionMedicationCoverage (20190430) (required) Definition: A concept that may be defined by a formal reference to a terminology or ontology or may be provided by text. Comments:
part (costSymbol)	0..1	BackboneElement	Definition: A symbolic representation of the relative cost of a unit of the product (e.g. '$$' or '$$$$+') Comments:
name	1..1	string	Fixed Value: costSymbol Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: costSymbol
value[x]	1..1	string	Max Length: 9 Definition: If the parameter is a data type.
part (unitCost)	0..1	BackboneElement	Definition: The estimated cost of a unit of the product in dollars 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.
name	1..1	string	Fixed Value: unitCost Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: unitCost
value[x]	1..1	Shared Health Money	qty-3: If a code for the unit is present, the system SHALL also be present Definition: A dollar amount expressed in Canadian funds 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.
part (costRange)	0..1	BackboneElement	Definition: A symbolic representation of the relative cost of a unit of the product (e.g. '$$' or '$$$$+') Comments:
name	1..1	string	Fixed Value: costRange Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: costRange
value[x]	1..1	string	Max Length: 20 Definition: If the parameter is a data type.
part (costUnit)	0..1	BackboneElement	Definition: The quantity of the drug associated with the cost symbol and cost range (e.g. 'per mg' or 'per 28 tablet package') Comments: Usage Note: Vendors should allow for 75 characters though this could be extended in the future.
name	1..1	string	Fixed Value: costUnit Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: costUnit
value[x]	1..1	string	Max Length: 75 Definition: If the parameter is a data type.
part (manufacturedProductUrl)	0..1	BackboneElement	Definition: A link to a web page or document where additional information can be found about the manufactured product Comments:
name	1..1	string	Fixed Value: manufacturedProductUrl Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: manufacturedProductUrl
value[x]	1..1	uri	Definition: If the parameter is a data type.
part (conditionalCoverageUrl)	0..1	BackboneElement	Definition: A link to a web page or document where additional information can be found about the formulary's conditional coverage rules Comments:
name	1..1	string	Fixed Value: conditionalCoverageUrl Definition: The name of the parameter (reference to the operation definition). Comments: Fixed value: conditionalCoverageUrl
value[x]	1..1	uri	Definition: If the parameter is a data type.

This structure is derived from Parameters

Summary

Mandatory: 14 elements (6 nested mandatory elements)
Must-Support: 37 elements
Fixed Value: 11 elements
Prohibited: 16 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

The element Parameters.meta.profile is sliced based on the value of value:value
The element Parameters.meta.tag is sliced based on the value of value:system
The element Parameters.parameter is sliced based on the value of value:name (Closed)
The element Parameters.parameter.part is sliced based on the value of value:name (Closed)

Differential View

This structure is derived from Parameters

Name	Flags	Card.	Type	Description & Constraints
Parameters	S	0..*	Parameters	Operation Request or Response
meta	S	1..1	Meta	Metadata about the resource
profile	S	1..*	(Slice Definition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:value
profile:profile	S	1..1	uri	Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/profile-parameters-formulary-response
tag	S	1..*	(Slice Definition)	Tags applied to this resource Slice: Unordered, Open by value:system
tag:version	S	1..1	Coding	Tags applied to this resource Binding: SharedSpecificationVersion (20210501) (required)
system	S	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
code	S	1..1	code	Symbol in syntax defined by the system
parameter	S	0..*	(Slice Definition)	Operation Parameter Slice: Unordered, Closed by value:name
parameter:product	S	1..*	BackboneElement	Formulary product
name	S	1..1	string	Name from the definition Fixed Value: product
part	S	2..8	(Slice Definition)	Named part of a parameter (e.g. Tuple) Slice: Unordered, Closed by value:name
part:code	S	1..1	BackboneElement	Name and code for product
name	S	1..1	string	Name from the definition Fixed Value: code
value[x]	S	1..1	Coding	If parameter is a data type Binding: PrescriptionMedicinalProduct (extensible)
code	S	1..1	code	Product code
display	S	1..1	string	Product name Max Length: 200
resource		0..0
part		0..0
part:coverage	S	1..1	BackboneElement	Is product covered?
name	S	1..1	string	Name from the definition Fixed Value: coverage
value[x]	S	1..1	Shared Health CodeableConcept Code	Concept - reference to a terminology or just text Binding: PrescriptionMedicationCoverage (20190430) (required)
resource		0..0
part		0..0
part:costSymbol	S	0..1	BackboneElement	Symbolic cost
name	S	1..1	string	Name from the definition Fixed Value: costSymbol
value[x]	S	1..1	string	If parameter is a data type Max Length: 9
resource		0..0
part		0..0
part:unitCost	S	0..1	BackboneElement	Unit Cost
name	S	1..1	string	Name from the definition Fixed Value: unitCost
value[x]	S	1..1	Shared Health Money	Canadian money
resource		0..0
part		0..0
part:costRange	S	0..1	BackboneElement	Cost range
name	S	1..1	string	Name from the definition Fixed Value: costRange
value[x]	S	1..1	string	If parameter is a data type Max Length: 20
resource		0..0
part		0..0
part:costUnit	S	0..1	BackboneElement	Cost unit
name	S	1..1	string	Name from the definition Fixed Value: costUnit
value[x]	S	1..1	string	If parameter is a data type Max Length: 75
resource		0..0
part		0..0
part:manufacturedProductUrl	S	0..1	BackboneElement	Manufactured Product URL
name	S	1..1	string	Name from the definition Fixed Value: manufacturedProductUrl
value[x]	S	1..1	uri	If parameter is a data type
resource		0..0
part		0..0
part:conditionalCoverageUrl	S	0..1	BackboneElement	Conditional Coverage URL
name	S	1..1	string	Name from the definition Fixed Value: conditionalCoverageUrl
value[x]	S	1..1	uri	If parameter is a data type
resource		0..0
part		0..0
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Parameters	S	0..*	Parameters	Operation Request or Response
id	Σ	0..1	id	Logical id of this artifact
meta	SΣ	1..1	Meta	Metadata about the resource
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
versionId	Σ	0..1	id	Version specific identifier
lastUpdated	Σ	0..1	instant	When the resource version last changed
profile	SΣ	1..*	(Slice Definition)	Profiles this resource claims to conform to Slice: Unordered, Open by value:value
profile:profile	SΣ	1..1	uri	Profiles this resource claims to conform to Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/profile-parameters-formulary-response
security	Σ	0..*	Coding	Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag	SΣ	1..*	(Slice Definition)	Tags applied to this resource Slice: Unordered, Open by value:system Binding: (unbound) (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
tag:version	SΣ	1..1	Coding	Tags applied to this resource Binding: SharedSpecificationVersion (20210501) (required)
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
system	SΣ	1..1	uri	Identity of the terminology system Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: http://tools.ietf.org/html/bcp47 (required): A human language.
parameter	SI	0..*	(Slice Definition)	Operation Parameter Slice: Unordered, Closed by value:name
parameter:All Slices				Content/Rules for all slices
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name		1..1	string	Name from the definition
value[x]	I	0..1		If parameter is a data type
valueBoolean			boolean
valueInteger			integer
valueDecimal			decimal
valueBase64Binary			base64Binary
valueInstant			instant
valueString			string
valueUri			uri
valueDate			date
valueDateTime			dateTime
valueTime			time
valueCode			code
valueOid			oid
valueId			id
valueUnsignedInt			unsignedInt
valuePositiveInt			positiveInt
valueMarkdown			markdown
valueAnnotation			Annotation
valueAttachment			Attachment
valueIdentifier			Identifier
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueQuantity			Quantity
valueRange			Range
valuePeriod			Period
valueRatio			Ratio
valueSampledData			SampledData
valueSignature			Signature
valueHumanName			HumanName
valueAddress			Address
valueContactPoint			ContactPoint
valueTiming			Timing
valueReference			Reference(Any)
valueMeta			Meta
resource	I	0..1	Resource	If parameter is a whole resource
part		0..*	See parameter (Parameters)	Named part of a parameter (e.g. Tuple)
parameter:product	SI	1..*	BackboneElement	Formulary product
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: product
value[x]	I	0..1		If parameter is a data type
valueBoolean			boolean
valueInteger			integer
valueDecimal			decimal
valueBase64Binary			base64Binary
valueInstant			instant
valueString			string
valueUri			uri
valueDate			date
valueDateTime			dateTime
valueTime			time
valueCode			code
valueOid			oid
valueId			id
valueUnsignedInt			unsignedInt
valuePositiveInt			positiveInt
valueMarkdown			markdown
valueAnnotation			Annotation
valueAttachment			Attachment
valueIdentifier			Identifier
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueQuantity			Quantity
valueRange			Range
valuePeriod			Period
valueRatio			Ratio
valueSampledData			SampledData
valueSignature			Signature
valueHumanName			HumanName
valueAddress			Address
valueContactPoint			ContactPoint
valueTiming			Timing
valueReference			Reference(Any)
valueMeta			Meta
resource	I	0..1	Resource	If parameter is a whole resource
part	S	2..8	(Slice Definition)	Named part of a parameter (e.g. Tuple) Slice: Unordered, Closed by value:name
part:code	S	1..1	BackboneElement	Name and code for product
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: code
value[x]	SI	1..1	Coding	If parameter is a data type Binding: PrescriptionMedicinalProduct (extensible)
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
system	Σ	0..1	uri	Identity of the terminology system
version	Σ	0..1	string	Version of the system - if relevant
code	SΣ	1..1	code	Product code
display	SΣ	1..1	string	Product name Max Length: 200
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
part:coverage	S	1..1	BackboneElement	Is product covered?
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: coverage
value[x]	S	1..1	Shared Health CodeableConcept Code	Concept - reference to a terminology or just text Binding: PrescriptionMedicationCoverage (20190430) (required)
part:costSymbol	S	0..1	BackboneElement	Symbolic cost
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: costSymbol
value[x]	SI	1..1	string	If parameter is a data type Max Length: 9
part:unitCost	S	0..1	BackboneElement	Unit Cost
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: unitCost
value[x]	SI	1..1	Shared Health Money	Canadian money
part:costRange	S	0..1	BackboneElement	Cost range
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: costRange
value[x]	SI	1..1	string	If parameter is a data type Max Length: 20
part:costUnit	S	0..1	BackboneElement	Cost unit
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: costUnit
value[x]	SI	1..1	string	If parameter is a data type Max Length: 75
part:manufacturedProductUrl	S	0..1	BackboneElement	Manufactured Product URL
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: manufacturedProductUrl
value[x]	SI	1..1	uri	If parameter is a data type
part:conditionalCoverageUrl	S	0..1	BackboneElement	Conditional Coverage URL
id		0..1	id	xml:id (or equivalent in JSON)
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored
name	S	1..1	string	Name from the definition Fixed Value: conditionalCoverageUrl
value[x]	SI	1..1	uri	If parameter is a data type
Documentation for this format

Other representations of profile: Schematron

3.63.3 Terminology Bindings

Terminology Bindings

Path	Conformance	ValueSet
Parameters.meta.security	extensible	All Security Labels
Parameters.meta.tag	example
Parameters.meta.tag:version	required	SharedSpecificationVersion
Parameters.language	required	http://tools.ietf.org/html/bcp47
Parameters.parameter:product.part:code.value[x]	extensible	PrescriptionMedicinalProduct
Parameters.parameter:product.part:coverage.value[x]	required	PrescriptionMedicationCoverage

3.63.4 Constraints

Constraints

Id	Path	Details	Requirements
inv-1	Parameters.parameter	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()))
inv-1	Parameters.parameter:product	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()))
qty-3	Parameters.parameter:product.part:unitCost.value[x]	If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists()