Specialty Medication Enrollment
2.0.0-ballot - STU 2 Ballot US

This page is part of the Specialty Medication Enrollment (v2.0.0-ballot: STU2 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: Specialty Rx Parameters - Query Response

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

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

Usage:

Formal Views of Profile Content

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

This structure is derived from Parameters

Summary

Mandatory: 2 elements
Must-Support: 10 elements
Fixed Value: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Parameters.parameter is sliced based on the value of value:name

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: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:search-result S1..*BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: search-result
..... value[x] S0..1Reference(Specialty Rx Bundle - Search Result)If parameter is a data type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... id Σ0..1stringLogical 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ΣI0..*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] ΣI0..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 ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:requester-patient SΣI1..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ΣI0..1Reference(Specialty Rx Patient)If parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:responder-patient SΣI0..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ΣI0..1Reference(Specialty Rx Patient)If parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:search-result SΣI1..*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: search-result
..... value[x] SΣI0..1Reference(Specialty Rx Bundle - Search Result)If parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter ΣI0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:requester-patient ΣI1..1BackboneElementOperation Parameter
..... name Σ1..1stringName from the definition
Fixed Value: requester-patient
..... value[x] ΣI0..1Reference(Specialty Rx Patient)If parameter is a data type
.... parameter:responder-patient ΣI0..1BackboneElementOperation Parameter
..... name Σ1..1stringName from the definition
Fixed Value: responder-patient
..... value[x] ΣI0..1Reference(Specialty Rx Patient)If parameter is a data type
.... parameter:search-result ΣI1..*BackboneElementOperation Parameter
..... name Σ1..1stringName from the definition
Fixed Value: search-result
..... value[x] ΣI0..1Reference(Specialty Rx Bundle - Search Result)If parameter is a data type

doco Documentation for this format

This structure is derived from Parameters

Summary

Mandatory: 2 elements
Must-Support: 10 elements
Fixed Value: 3 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element Parameters.parameter is sliced based on the value of value:name

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: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:search-result S1..*BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: search-result
..... value[x] S0..1Reference(Specialty Rx Bundle - Search Result)If parameter is a data type

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... id Σ0..1stringLogical 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ΣI0..*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] ΣI0..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 ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:requester-patient SΣI1..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ΣI0..1Reference(Specialty Rx Patient)If parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:responder-patient SΣI0..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ΣI0..1Reference(Specialty Rx Patient)If parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:search-result SΣI1..*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: search-result
..... value[x] SΣI0..1Reference(Specialty Rx Bundle - Search Result)If parameter is a data type
..... resource ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Parameters.languagepreferredCommonLanguages
Max Binding: AllLanguages

Constraints

IdGradePathDetailsRequirements
ele-1errorParameters.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1errorParameters.parameterA 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()))
ele-1errorParameters.parameter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorParameters.parameter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorParameters.parameter.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorParameters.parameter.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorParameters.parameter.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameter.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameter.partAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameter:requester-patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1errorParameters.parameter:requester-patientA 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()))
ele-1errorParameters.parameter:requester-patient.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorParameters.parameter:requester-patient.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorParameters.parameter:requester-patient.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorParameters.parameter:requester-patient.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorParameters.parameter:requester-patient.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameter:requester-patient.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameter:requester-patient.partAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameter:responder-patientAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1errorParameters.parameter:responder-patientA 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()))
ele-1errorParameters.parameter:responder-patient.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorParameters.parameter:responder-patient.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorParameters.parameter:responder-patient.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorParameters.parameter:responder-patient.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorParameters.parameter:responder-patient.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameter:responder-patient.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameter:responder-patient.partAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameter:search-resultAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1errorParameters.parameter:search-resultA 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()))
ele-1errorParameters.parameter:search-result.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorParameters.parameter:search-result.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorParameters.parameter:search-result.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1errorParameters.parameter:search-result.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1errorParameters.parameter:search-result.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameter:search-result.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1errorParameters.parameter:search-result.partAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())