PrescribeIT® Specification and Guide Version 5.0

 

The official URL for this profile is:

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

Download Excel representation

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

>

This structure is derived from Parameters

NameCard.TypeConstraints and Usage
.  Parameters 0..*ParametersDefinition:
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..1MetaDefinition:
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..*uriSlice: 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..1uriFixed 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..*CodingSlice: 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..1CodingBinding: 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..1uriFixed 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..1codeDefinition:
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..*BackboneElementSlice: 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..*BackboneElementinv-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..1stringFixed Value: product
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: product

...  part 2..8See 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..1BackboneElementDefinition:
A code indicating whether the specified product is covered within the specified jurisdiction's formulary


Comments:
 

....  name 1..1stringFixed Value: code
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: code

....  value[x] 1..1CodingBinding: PrescriptionMedicinalProduct (extensible)
Definition:
If the parameter is a data type.

.....  code 1..1codeDefinition:
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..1stringMax 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..1BackboneElementDefinition:
A code indicating whether the specified product is covered within the specified jurisdiction's formulary


Comments:
 

....  name 1..1stringFixed Value: coverage
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: coverage

....  value[x] 1..1Shared Health CodeableConcept CodeBinding: 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..1BackboneElementDefinition:
A symbolic representation of the relative cost of a unit of the product (e.g. '$$' or '$$$$+')


Comments:
 

....  name 1..1stringFixed Value: costSymbol
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: costSymbol

....  value[x] 1..1stringMax Length: 9
Definition:
If the parameter is a data type.

...  part
       (unitCost)
0..1BackboneElementDefinition:
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..1stringFixed Value: unitCost
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: unitCost

....  value[x] 1..1Shared Health Moneyqty-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..1BackboneElementDefinition:
A symbolic representation of the relative cost of a unit of the product (e.g. '$$' or '$$$$+')


Comments:
 

....  name 1..1stringFixed Value: costRange
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: costRange

....  value[x] 1..1stringMax Length: 20
Definition:
If the parameter is a data type.

...  part
       (costUnit)
0..1BackboneElementDefinition:
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..1stringFixed Value: costUnit
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: costUnit

....  value[x] 1..1stringMax Length: 75
Definition:
If the parameter is a data type.

...  part
       (manufacturedProductUrl)
0..1BackboneElementDefinition:
A link to a web page or document where additional information can be found about the manufactured product


Comments:
 

....  name 1..1stringFixed Value: manufacturedProductUrl
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: manufacturedProductUrl

....  value[x] 1..1uriDefinition:
If the parameter is a data type.

...  part
       (conditionalCoverageUrl)
0..1BackboneElementDefinition:
A link to a web page or document where additional information can be found about the formulary's conditional coverage rules


Comments:
 

....  name 1..1stringFixed Value: conditionalCoverageUrl
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: conditionalCoverageUrl

....  value[x] 1..1uriDefinition:
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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters S0..*ParametersOperation Request or Response
... meta S1..1MetaMetadata about the resource
.... profile S1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:profile S1..1uriProfiles this resource claims to conform to
Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/profile-parameters-formulary-response
.... tag S1..*(Slice Definition)Tags applied to this resource
Slice: Unordered, Open by value:system
..... tag:version S1..1CodingTags applied to this resource
Binding: SharedSpecificationVersion (20210501) (required)
...... system S1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
...... code S1..1codeSymbol in syntax defined by the system
... parameter S0..*(Slice Definition)Operation Parameter
Slice: Unordered, Closed by value:name
.... parameter:product S1..*BackboneElementFormulary product
..... name S1..1stringName from the definition
Fixed Value: product
..... part S2..8(Slice Definition)Named part of a parameter (e.g. Tuple)
Slice: Unordered, Closed by value:name
...... part:code S1..1BackboneElementName and code for product
....... name S1..1stringName from the definition
Fixed Value: code
....... value[x] S1..1CodingIf parameter is a data type
Binding: PrescriptionMedicinalProduct (extensible)
........ code S1..1codeProduct code
........ display S1..1stringProduct name
Max Length: 200
....... resource 0..0
....... part 0..0
...... part:coverage S1..1BackboneElementIs product covered?
....... name S1..1stringName from the definition
Fixed Value: coverage
....... value[x] S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: PrescriptionMedicationCoverage (20190430) (required)
....... resource 0..0
....... part 0..0
...... part:costSymbol S0..1BackboneElementSymbolic cost
....... name S1..1stringName from the definition
Fixed Value: costSymbol
....... value[x] S1..1stringIf parameter is a data type
Max Length: 9
....... resource 0..0
....... part 0..0
...... part:unitCost S0..1BackboneElementUnit Cost
....... name S1..1stringName from the definition
Fixed Value: unitCost
....... value[x] S1..1Shared Health MoneyCanadian money
....... resource 0..0
....... part 0..0
...... part:costRange S0..1BackboneElementCost range
....... name S1..1stringName from the definition
Fixed Value: costRange
....... value[x] S1..1stringIf parameter is a data type
Max Length: 20
....... resource 0..0
....... part 0..0
...... part:costUnit S0..1BackboneElementCost unit
....... name S1..1stringName from the definition
Fixed Value: costUnit
....... value[x] S1..1stringIf parameter is a data type
Max Length: 75
....... resource 0..0
....... part 0..0
...... part:manufacturedProductUrl S0..1BackboneElementManufactured Product URL
....... name S1..1stringName from the definition
Fixed Value: manufacturedProductUrl
....... value[x] S1..1uriIf parameter is a data type
....... resource 0..0
....... part 0..0
...... part:conditionalCoverageUrl S0..1BackboneElementConditional Coverage URL
....... name S1..1stringName from the definition
Fixed Value: conditionalCoverageUrl
....... value[x] S1..1uriIf parameter is a data type
....... resource 0..0
....... part 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters S0..*ParametersOperation Request or Response
... id Σ0..1idLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen 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..1uriProfiles this resource claims to conform to

Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/profile-parameters-formulary-response
.... security Σ0..*CodingSecurity 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..1CodingTags applied to this resource
Binding: SharedSpecificationVersion (20210501) (required)
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... parameter SI0..*(Slice Definition)Operation Parameter
Slice: Unordered, Closed by value:name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... name 1..1stringName from the definition
..... value[x] I0..1If parameter is a data type
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueBase64Binarybase64Binary
...... valueInstantinstant
...... valueStringstring
...... valueUriuri
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueCodecode
...... valueOidoid
...... valueIdid
...... valueUnsignedIntunsignedInt
...... valuePositiveIntpositiveInt
...... valueMarkdownmarkdown
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueIdentifierIdentifier
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueQuantityQuantity
...... valueRangeRange
...... valuePeriodPeriod
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueHumanNameHumanName
...... valueAddressAddress
...... valueContactPointContactPoint
...... valueTimingTiming
...... valueReferenceReference(Any)
...... valueMetaMeta
..... resource I0..1ResourceIf parameter is a whole resource
..... part 0..*See parameter (Parameters)Named part of a parameter (e.g. Tuple)
.... parameter:product SI1..*BackboneElementFormulary product
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... name S1..1stringName from the definition
Fixed Value: product
..... value[x] I0..1If parameter is a data type
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueBase64Binarybase64Binary
...... valueInstantinstant
...... valueStringstring
...... valueUriuri
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueCodecode
...... valueOidoid
...... valueIdid
...... valueUnsignedIntunsignedInt
...... valuePositiveIntpositiveInt
...... valueMarkdownmarkdown
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueIdentifierIdentifier
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueQuantityQuantity
...... valueRangeRange
...... valuePeriodPeriod
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueHumanNameHumanName
...... valueAddressAddress
...... valueContactPointContactPoint
...... valueTimingTiming
...... valueReferenceReference(Any)
...... valueMetaMeta
..... resource I0..1ResourceIf parameter is a whole resource
..... part S2..8(Slice Definition)Named part of a parameter (e.g. Tuple)
Slice: Unordered, Closed by value:name
...... part:code S1..1BackboneElementName and code for product
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: code
....... value[x] SI1..1CodingIf parameter is a data type
Binding: PrescriptionMedicinalProduct (extensible)
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
........ system Σ0..1uriIdentity of the terminology system
........ version Σ0..1stringVersion of the system - if relevant
........ code SΣ1..1codeProduct code
........ display SΣ1..1stringProduct name
Max Length: 200
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... part:coverage S1..1BackboneElementIs product covered?
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: coverage
....... value[x] S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: PrescriptionMedicationCoverage (20190430) (required)
...... part:costSymbol S0..1BackboneElementSymbolic cost
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: costSymbol
....... value[x] SI1..1stringIf parameter is a data type
Max Length: 9
...... part:unitCost S0..1BackboneElementUnit Cost
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: unitCost
....... value[x] SI1..1Shared Health MoneyCanadian money
...... part:costRange S0..1BackboneElementCost range
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: costRange
....... value[x] SI1..1stringIf parameter is a data type
Max Length: 20
...... part:costUnit S0..1BackboneElementCost unit
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: costUnit
....... value[x] SI1..1stringIf parameter is a data type
Max Length: 75
...... part:manufacturedProductUrl S0..1BackboneElementManufactured Product URL
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: manufacturedProductUrl
....... value[x] SI1..1uriIf parameter is a data type
...... part:conditionalCoverageUrl S0..1BackboneElementConditional Coverage URL
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: conditionalCoverageUrl
....... value[x] SI1..1uriIf parameter is a data type

doco Documentation for this format

Grid View

This structure is derived from Parameters

NameCard.TypeConstraints and Usage
.  Parameters 0..*ParametersDefinition:
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..1MetaDefinition:
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..*uriSlice: 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..1uriFixed 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..*CodingSlice: 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..1CodingBinding: 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..1uriFixed 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..1codeDefinition:
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..*BackboneElementSlice: 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..*BackboneElementinv-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..1stringFixed Value: product
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: product

...  part 2..8See 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..1BackboneElementDefinition:
A code indicating whether the specified product is covered within the specified jurisdiction's formulary


Comments:
 

....  name 1..1stringFixed Value: code
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: code

....  value[x] 1..1CodingBinding: PrescriptionMedicinalProduct (extensible)
Definition:
If the parameter is a data type.

.....  code 1..1codeDefinition:
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..1stringMax 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..1BackboneElementDefinition:
A code indicating whether the specified product is covered within the specified jurisdiction's formulary


Comments:
 

....  name 1..1stringFixed Value: coverage
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: coverage

....  value[x] 1..1Shared Health CodeableConcept CodeBinding: 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..1BackboneElementDefinition:
A symbolic representation of the relative cost of a unit of the product (e.g. '$$' or '$$$$+')


Comments:
 

....  name 1..1stringFixed Value: costSymbol
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: costSymbol

....  value[x] 1..1stringMax Length: 9
Definition:
If the parameter is a data type.

...  part
       (unitCost)
0..1BackboneElementDefinition:
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..1stringFixed Value: unitCost
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: unitCost

....  value[x] 1..1Shared Health Moneyqty-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..1BackboneElementDefinition:
A symbolic representation of the relative cost of a unit of the product (e.g. '$$' or '$$$$+')


Comments:
 

....  name 1..1stringFixed Value: costRange
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: costRange

....  value[x] 1..1stringMax Length: 20
Definition:
If the parameter is a data type.

...  part
       (costUnit)
0..1BackboneElementDefinition:
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..1stringFixed Value: costUnit
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: costUnit

....  value[x] 1..1stringMax Length: 75
Definition:
If the parameter is a data type.

...  part
       (manufacturedProductUrl)
0..1BackboneElementDefinition:
A link to a web page or document where additional information can be found about the manufactured product


Comments:
 

....  name 1..1stringFixed Value: manufacturedProductUrl
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: manufacturedProductUrl

....  value[x] 1..1uriDefinition:
If the parameter is a data type.

...  part
       (conditionalCoverageUrl)
0..1BackboneElementDefinition:
A link to a web page or document where additional information can be found about the formulary's conditional coverage rules


Comments:
 

....  name 1..1stringFixed Value: conditionalCoverageUrl
Definition:
The name of the parameter (reference to the operation definition).


Comments:
Fixed value: conditionalCoverageUrl

....  value[x] 1..1uriDefinition:
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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters S0..*ParametersOperation Request or Response
... meta S1..1MetaMetadata about the resource
.... profile S1..*(Slice Definition)Profiles this resource claims to conform to
Slice: Unordered, Open by value:value
..... profile:profile S1..1uriProfiles this resource claims to conform to
Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/profile-parameters-formulary-response
.... tag S1..*(Slice Definition)Tags applied to this resource
Slice: Unordered, Open by value:system
..... tag:version S1..1CodingTags applied to this resource
Binding: SharedSpecificationVersion (20210501) (required)
...... system S1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
...... code S1..1codeSymbol in syntax defined by the system
... parameter S0..*(Slice Definition)Operation Parameter
Slice: Unordered, Closed by value:name
.... parameter:product S1..*BackboneElementFormulary product
..... name S1..1stringName from the definition
Fixed Value: product
..... part S2..8(Slice Definition)Named part of a parameter (e.g. Tuple)
Slice: Unordered, Closed by value:name
...... part:code S1..1BackboneElementName and code for product
....... name S1..1stringName from the definition
Fixed Value: code
....... value[x] S1..1CodingIf parameter is a data type
Binding: PrescriptionMedicinalProduct (extensible)
........ code S1..1codeProduct code
........ display S1..1stringProduct name
Max Length: 200
....... resource 0..0
....... part 0..0
...... part:coverage S1..1BackboneElementIs product covered?
....... name S1..1stringName from the definition
Fixed Value: coverage
....... value[x] S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: PrescriptionMedicationCoverage (20190430) (required)
....... resource 0..0
....... part 0..0
...... part:costSymbol S0..1BackboneElementSymbolic cost
....... name S1..1stringName from the definition
Fixed Value: costSymbol
....... value[x] S1..1stringIf parameter is a data type
Max Length: 9
....... resource 0..0
....... part 0..0
...... part:unitCost S0..1BackboneElementUnit Cost
....... name S1..1stringName from the definition
Fixed Value: unitCost
....... value[x] S1..1Shared Health MoneyCanadian money
....... resource 0..0
....... part 0..0
...... part:costRange S0..1BackboneElementCost range
....... name S1..1stringName from the definition
Fixed Value: costRange
....... value[x] S1..1stringIf parameter is a data type
Max Length: 20
....... resource 0..0
....... part 0..0
...... part:costUnit S0..1BackboneElementCost unit
....... name S1..1stringName from the definition
Fixed Value: costUnit
....... value[x] S1..1stringIf parameter is a data type
Max Length: 75
....... resource 0..0
....... part 0..0
...... part:manufacturedProductUrl S0..1BackboneElementManufactured Product URL
....... name S1..1stringName from the definition
Fixed Value: manufacturedProductUrl
....... value[x] S1..1uriIf parameter is a data type
....... resource 0..0
....... part 0..0
...... part:conditionalCoverageUrl S0..1BackboneElementConditional Coverage URL
....... name S1..1stringName from the definition
Fixed Value: conditionalCoverageUrl
....... value[x] S1..1uriIf parameter is a data type
....... resource 0..0
....... part 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters S0..*ParametersOperation Request or Response
... id Σ0..1idLogical id of this artifact
... meta SΣ1..1MetaMetadata about the resource
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... versionId Σ0..1idVersion specific identifier
.... lastUpdated Σ0..1instantWhen 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..1uriProfiles this resource claims to conform to

Fixed Value: http://prescribeit.ca/fhir/StructureDefinition/profile-parameters-formulary-response
.... security Σ0..*CodingSecurity 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..1CodingTags applied to this resource
Binding: SharedSpecificationVersion (20210501) (required)
...... id 0..1idxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional Content defined by implementations
...... system SΣ1..1uriIdentity of the terminology system
Fixed Value: https://fhir.infoway-inforoute.ca/CodeSystem/sharedspecificationversion
...... version Σ0..1stringVersion of the system - if relevant
...... code SΣ1..1codeSymbol in syntax defined by the system
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required): A human language.


... parameter SI0..*(Slice Definition)Operation Parameter
Slice: Unordered, Closed by value:name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... name 1..1stringName from the definition
..... value[x] I0..1If parameter is a data type
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueBase64Binarybase64Binary
...... valueInstantinstant
...... valueStringstring
...... valueUriuri
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueCodecode
...... valueOidoid
...... valueIdid
...... valueUnsignedIntunsignedInt
...... valuePositiveIntpositiveInt
...... valueMarkdownmarkdown
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueIdentifierIdentifier
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueQuantityQuantity
...... valueRangeRange
...... valuePeriodPeriod
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueHumanNameHumanName
...... valueAddressAddress
...... valueContactPointContactPoint
...... valueTimingTiming
...... valueReferenceReference(Any)
...... valueMetaMeta
..... resource I0..1ResourceIf parameter is a whole resource
..... part 0..*See parameter (Parameters)Named part of a parameter (e.g. Tuple)
.... parameter:product SI1..*BackboneElementFormulary product
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... name S1..1stringName from the definition
Fixed Value: product
..... value[x] I0..1If parameter is a data type
...... valueBooleanboolean
...... valueIntegerinteger
...... valueDecimaldecimal
...... valueBase64Binarybase64Binary
...... valueInstantinstant
...... valueStringstring
...... valueUriuri
...... valueDatedate
...... valueDateTimedateTime
...... valueTimetime
...... valueCodecode
...... valueOidoid
...... valueIdid
...... valueUnsignedIntunsignedInt
...... valuePositiveIntpositiveInt
...... valueMarkdownmarkdown
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueIdentifierIdentifier
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueQuantityQuantity
...... valueRangeRange
...... valuePeriodPeriod
...... valueRatioRatio
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueHumanNameHumanName
...... valueAddressAddress
...... valueContactPointContactPoint
...... valueTimingTiming
...... valueReferenceReference(Any)
...... valueMetaMeta
..... resource I0..1ResourceIf parameter is a whole resource
..... part S2..8(Slice Definition)Named part of a parameter (e.g. Tuple)
Slice: Unordered, Closed by value:name
...... part:code S1..1BackboneElementName and code for product
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: code
....... value[x] SI1..1CodingIf parameter is a data type
Binding: PrescriptionMedicinalProduct (extensible)
........ id 0..1idxml:id (or equivalent in JSON)
........ extension 0..*ExtensionAdditional Content defined by implementations
........ system Σ0..1uriIdentity of the terminology system
........ version Σ0..1stringVersion of the system - if relevant
........ code SΣ1..1codeProduct code
........ display SΣ1..1stringProduct name
Max Length: 200
........ userSelected Σ0..1booleanIf this coding was chosen directly by the user
...... part:coverage S1..1BackboneElementIs product covered?
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: coverage
....... value[x] S1..1Shared Health CodeableConcept CodeConcept - reference to a terminology or just text
Binding: PrescriptionMedicationCoverage (20190430) (required)
...... part:costSymbol S0..1BackboneElementSymbolic cost
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: costSymbol
....... value[x] SI1..1stringIf parameter is a data type
Max Length: 9
...... part:unitCost S0..1BackboneElementUnit Cost
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: unitCost
....... value[x] SI1..1Shared Health MoneyCanadian money
...... part:costRange S0..1BackboneElementCost range
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: costRange
....... value[x] SI1..1stringIf parameter is a data type
Max Length: 20
...... part:costUnit S0..1BackboneElementCost unit
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: costUnit
....... value[x] SI1..1stringIf parameter is a data type
Max Length: 75
...... part:manufacturedProductUrl S0..1BackboneElementManufactured Product URL
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: manufacturedProductUrl
....... value[x] SI1..1uriIf parameter is a data type
...... part:conditionalCoverageUrl S0..1BackboneElementConditional Coverage URL
....... id 0..1idxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional Content defined by implementations
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
....... name S1..1stringName from the definition
Fixed Value: conditionalCoverageUrl
....... value[x] SI1..1uriIf parameter is a data type

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

PathConformanceValueSet
Parameters.meta.securityextensibleAll Security Labels
Parameters.meta.tagexample
Parameters.meta.tag:versionrequiredSharedSpecificationVersion
Parameters.languagerequiredhttp://tools.ietf.org/html/bcp47
Parameters.parameter:product.part:code.value[x]extensiblePrescriptionMedicinalProduct
Parameters.parameter:product.part:coverage.value[x]requiredPrescriptionMedicationCoverage

Constraints

IdPathDetailsRequirements
inv-1Parameters.parameterA 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-1Parameters.parameter:productA 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-3Parameters.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()