Specialty Medication Enrollment
2.0.0 - STU2 US United States of America flag

This page is part of the Specialty Medication Enrollment (v2.0.0: STU2) based on FHIR R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Resource Profile: Specialty Rx Parameters - Query

Official URL: http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-parameters-query Version: 2.0.0
Active as of 2020-07-02 Computable Name: SpecialtyRxParametersQuery

This profile tailors the Parameters resource to convey Specialty Rx Query inputs.

Example. This profile is illustrated in the following full message example:

Usage:

Formal Views of Profile Content

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

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter S0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:query-string S1..*BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: query-string
..... value[x] 0..1stringIf parameter is a data type
.... parameter:requester-patient S1..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: requester-patient
..... value[x] S0..1Reference(Specialty Rx Patient)If parameter is a data type
.... parameter:responder-patient S0..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: responder-patient
..... value[x] S0..1Reference(Specialty Rx Patient)If parameter is a data type
.... parameter:prescription S0..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: prescription
..... value[x] S0..1Reference(Specialty Prescription)If parameter is a data type
.... parameter:pharmacy S0..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: pharmacy
..... value[x] S0..1Reference(Specialty Rx Organization - Pharmacy)If parameter is a data type
.... parameter:prescriber S0..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: prescriber
..... value[x] S0..1Reference(Specialty Prescription Practitioner)If parameter is a data type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter SΣC0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
.... parameter:query-string SΣC1..*BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: query-string
..... value[x] ΣC0..1stringIf parameter is a data type
.... parameter:requester-patient SΣC1..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: requester-patient
..... value[x] SΣC0..1Reference(Specialty Rx Patient)If parameter is a data type
.... parameter:responder-patient SΣC0..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: responder-patient
..... value[x] SΣC0..1Reference(Specialty Rx Patient)If parameter is a data type
.... parameter:prescription SΣC0..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: prescription
..... value[x] SΣC0..1Reference(Specialty Prescription)If parameter is a data type
.... parameter:pharmacy SΣC0..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: pharmacy
..... value[x] SΣC0..1Reference(Specialty Rx Organization - Pharmacy)If parameter is a data type
.... parameter:prescriber SΣC0..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: prescriber
..... value[x] SΣC0..1Reference(Specialty Prescription Practitioner)If parameter is a data type

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:query-string, Parameters.parameter:requester-patient, Parameters.parameter:responder-patient, Parameters.parameter:prescription, Parameters.parameter:pharmacy, Parameters.parameter:prescriberA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter SΣC0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
..... value[x] ΣC0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:query-string SΣC1..*BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: query-string
..... value[x] ΣC0..1stringIf parameter is a data type
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:requester-patient SΣC1..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: requester-patient
..... value[x] SΣC0..1Reference(Specialty Rx Patient)If parameter is a data type
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:responder-patient SΣC0..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: responder-patient
..... value[x] SΣC0..1Reference(Specialty Rx Patient)If parameter is a data type
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:prescription SΣC0..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: prescription
..... value[x] SΣC0..1Reference(Specialty Prescription)If parameter is a data type
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:pharmacy SΣC0..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: pharmacy
..... value[x] SΣC0..1Reference(Specialty Rx Organization - Pharmacy)If parameter is a data type
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:prescriber SΣC0..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: prescriber
..... value[x] SΣC0..1Reference(Specialty Prescription Practitioner)If parameter is a data type
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:query-string, Parameters.parameter:requester-patient, Parameters.parameter:responder-patient, Parameters.parameter:prescription, Parameters.parameter:pharmacy, Parameters.parameter:prescriberA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter S0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:query-string S1..*BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: query-string
..... value[x] 0..1stringIf parameter is a data type
.... parameter:requester-patient S1..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: requester-patient
..... value[x] S0..1Reference(Specialty Rx Patient)If parameter is a data type
.... parameter:responder-patient S0..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: responder-patient
..... value[x] S0..1Reference(Specialty Rx Patient)If parameter is a data type
.... parameter:prescription S0..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: prescription
..... value[x] S0..1Reference(Specialty Prescription)If parameter is a data type
.... parameter:pharmacy S0..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: pharmacy
..... value[x] S0..1Reference(Specialty Rx Organization - Pharmacy)If parameter is a data type
.... parameter:prescriber S0..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: prescriber
..... value[x] S0..1Reference(Specialty Prescription Practitioner)If parameter is a data type

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter SΣC0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
.... parameter:query-string SΣC1..*BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: query-string
..... value[x] ΣC0..1stringIf parameter is a data type
.... parameter:requester-patient SΣC1..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: requester-patient
..... value[x] SΣC0..1Reference(Specialty Rx Patient)If parameter is a data type
.... parameter:responder-patient SΣC0..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: responder-patient
..... value[x] SΣC0..1Reference(Specialty Rx Patient)If parameter is a data type
.... parameter:prescription SΣC0..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: prescription
..... value[x] SΣC0..1Reference(Specialty Prescription)If parameter is a data type
.... parameter:pharmacy SΣC0..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: pharmacy
..... value[x] SΣC0..1Reference(Specialty Rx Organization - Pharmacy)If parameter is a data type
.... parameter:prescriber SΣC0..1BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: prescriber
..... value[x] SΣC0..1Reference(Specialty Prescription Practitioner)If parameter is a data type

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:query-string, Parameters.parameter:requester-patient, Parameters.parameter:responder-patient, Parameters.parameter:prescription, Parameters.parameter:pharmacy, Parameters.parameter:prescriberA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter SΣC0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
..... value[x] ΣC0..1If parameter is a data type
...... valueBase64Binarybase64Binary
...... valueBooleanboolean
...... valueCanonicalcanonical(Any)
...... valueCodecode
...... valueDatedate
...... valueDateTimedateTime
...... valueDecimaldecimal
...... valueIdid
...... valueInstantinstant
...... valueIntegerinteger
...... valueMarkdownmarkdown
...... valueOidoid
...... valuePositiveIntpositiveInt
...... valueStringstring
...... valueTimetime
...... valueUnsignedIntunsignedInt
...... valueUriuri
...... valueUrlurl
...... valueUuiduuid
...... valueAddressAddress
...... valueAgeAge
...... valueAnnotationAnnotation
...... valueAttachmentAttachment
...... valueCodeableConceptCodeableConcept
...... valueCodingCoding
...... valueContactPointContactPoint
...... valueCountCount
...... valueDistanceDistance
...... valueDurationDuration
...... valueHumanNameHumanName
...... valueIdentifierIdentifier
...... valueMoneyMoney
...... valuePeriodPeriod
...... valueQuantityQuantity
...... valueRangeRange
...... valueRatioRatio
...... valueReferenceReference(Any)
...... valueSampledDataSampledData
...... valueSignatureSignature
...... valueTimingTiming
...... valueContactDetailContactDetail
...... valueContributorContributor
...... valueDataRequirementDataRequirement
...... valueExpressionExpression
...... valueParameterDefinitionParameterDefinition
...... valueRelatedArtifactRelatedArtifact
...... valueTriggerDefinitionTriggerDefinition
...... valueUsageContextUsageContext
...... valueDosageDosage
...... valueMetaMeta
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:query-string SΣC1..*BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: query-string
..... value[x] ΣC0..1stringIf parameter is a data type
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:requester-patient SΣC1..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: requester-patient
..... value[x] SΣC0..1Reference(Specialty Rx Patient)If parameter is a data type
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:responder-patient SΣC0..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: responder-patient
..... value[x] SΣC0..1Reference(Specialty Rx Patient)If parameter is a data type
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:prescription SΣC0..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: prescription
..... value[x] SΣC0..1Reference(Specialty Prescription)If parameter is a data type
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:pharmacy SΣC0..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: pharmacy
..... value[x] SΣC0..1Reference(Specialty Rx Organization - Pharmacy)If parameter is a data type
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:prescriber SΣC0..1BackboneElementOperation Parameter
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name SΣ1..1stringName from the definition
Fixed Value: prescriber
..... value[x] SΣC0..1Reference(Specialty Prescription Practitioner)If parameter is a data type
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:query-string, Parameters.parameter:requester-patient, Parameters.parameter:responder-patient, Parameters.parameter:prescription, Parameters.parameter:pharmacy, Parameters.parameter:prescriberA parameter must have one and only one of (value, resource, part)
: (part.exists() and value.empty() and resource.empty()) or (part.empty() and (value.exists() xor resource.exists()))

 

Other representations of profile: CSV, Excel, Schematron