HL7.FHIR.US.SPECIALTY-RX\Specialty Rx Parameters - Query Response

Specialty Medication Enrollment
1.0.0 - STU 1

This page is part of the Specialty Medication Enrollment (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. The current version which supersedes this version is 2.0.0. For a full list of available versions, see the Directory of published versions

Resource Profile: Specialty Rx Parameters - Query Response

Defining URL:

http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-parameters-query-response

Version:

1.0.0

Name:

SpecialtyRxParametersQueryResponse

Title:

Specialty Rx Parameters - Query Response

Status:

Active as of 2020-07-20T00:00:00-05:00

Definition:

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

Publisher:

HL7 International - Pharmacy

Source Resource:

XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-parameters-query-response

Formal Views of Profile Content

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

Text Summary
Differential Table
Snapshot Table
Snapshot Table (Must Support)
All

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

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
Slices for parameter	S	0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:requester-patient	S	1..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: requester-patient
value[x]	S	0..1	Reference(Specialty Rx Patient)	If parameter is a data type
parameter:responder-patient	S	0..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: responder-patient
value[x]	S	0..1	Reference(Specialty Rx Patient)	If parameter is a data type
parameter:search-result	S	1..*	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: search-result
value[x]	S	0..1	Reference(Specialty Rx Bundle - Search Result)	If parameter is a data type
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
Slices for parameter	SΣI	0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition
value[x]	ΣI	0..1		If parameter is a data type
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
resource	ΣI	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:requester-patient	SΣI	1..1	BackboneElement	Operation Parameter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: requester-patient
value[x]	SΣI	0..1	Reference(Specialty Rx Patient)	If parameter is a data type
resource	ΣI	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:responder-patient	SΣI	0..1	BackboneElement	Operation Parameter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: responder-patient
value[x]	SΣI	0..1	Reference(Specialty Rx Patient)	If parameter is a data type
resource	ΣI	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:search-result	SΣI	1..*	BackboneElement	Operation Parameter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: search-result
value[x]	SΣI	0..1	Reference(Specialty Rx Bundle - Search Result)	If parameter is a data type
resource	ΣI	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
Slices for parameter	ΣI	0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:requester-patient	ΣI	1..1	BackboneElement	Operation Parameter
name	Σ	1..1	string	Name from the definition Fixed Value: requester-patient
value[x]	ΣI	0..1	Reference(Specialty Rx Patient)	If parameter is a data type
parameter:responder-patient	ΣI	0..1	BackboneElement	Operation Parameter
name	Σ	1..1	string	Name from the definition Fixed Value: responder-patient
value[x]	ΣI	0..1	Reference(Specialty Rx Patient)	If parameter is a data type
parameter:search-result	ΣI	1..*	BackboneElement	Operation Parameter
name	Σ	1..1	string	Name from the definition Fixed Value: search-result
value[x]	ΣI	0..1	Reference(Specialty Rx Bundle - Search Result)	If parameter is a data type
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

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
Slices for parameter	S	0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:requester-patient	S	1..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: requester-patient
value[x]	S	0..1	Reference(Specialty Rx Patient)	If parameter is a data type
parameter:responder-patient	S	0..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: responder-patient
value[x]	S	0..1	Reference(Specialty Rx Patient)	If parameter is a data type
parameter:search-result	S	1..*	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: search-result
value[x]	S	0..1	Reference(Specialty Rx Bundle - Search Result)	If parameter is a data type
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
id	Σ	0..1	string	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language.
Slices for parameter	SΣI	0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition
value[x]	ΣI	0..1		If parameter is a data type
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
resource	ΣI	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:requester-patient	SΣI	1..1	BackboneElement	Operation Parameter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: requester-patient
value[x]	SΣI	0..1	Reference(Specialty Rx Patient)	If parameter is a data type
resource	ΣI	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:responder-patient	SΣI	0..1	BackboneElement	Operation Parameter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: responder-patient
value[x]	SΣI	0..1	Reference(Specialty Rx Patient)	If parameter is a data type
resource	ΣI	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:search-result	SΣI	1..*	BackboneElement	Operation Parameter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: search-result
value[x]	SΣI	0..1	Reference(Specialty Rx Bundle - Search Result)	If parameter is a data type
resource	ΣI	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

Path	Conformance	ValueSet
Parameters.language	preferred	CommonLanguages Max Binding: AllLanguages

Constraints

Id	Path	Details	Requirements
ele-1	Parameters.meta	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Parameters.implicitRules	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Parameters.language	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Parameters.parameter	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
inv-1	Parameters.parameter	A 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-1	Parameters.parameter.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Parameters.parameter.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Parameters.parameter.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Parameters.parameter.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Parameters.parameter.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Parameters.parameter.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Parameters.parameter.part	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Parameters.parameter:requester-patient	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
inv-1	Parameters.parameter:requester-patient	A 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-1	Parameters.parameter:requester-patient.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Parameters.parameter:requester-patient.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Parameters.parameter:requester-patient.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Parameters.parameter:requester-patient.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Parameters.parameter:requester-patient.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Parameters.parameter:requester-patient.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Parameters.parameter:requester-patient.part	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Parameters.parameter:responder-patient	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
inv-1	Parameters.parameter:responder-patient	A 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-1	Parameters.parameter:responder-patient.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Parameters.parameter:responder-patient.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Parameters.parameter:responder-patient.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Parameters.parameter:responder-patient.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Parameters.parameter:responder-patient.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Parameters.parameter:responder-patient.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Parameters.parameter:responder-patient.part	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Parameters.parameter:search-result	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
inv-1	Parameters.parameter:search-result	A 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-1	Parameters.parameter:search-result.extension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Parameters.parameter:search-result.extension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Parameters.parameter:search-result.modifierExtension	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	Parameters.parameter:search-result.modifierExtension	Must have either extensions or value[x], not both : extension.exists() != value.exists()
ele-1	Parameters.parameter:search-result.name	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Parameters.parameter:search-result.value[x]	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ele-1	Parameters.parameter:search-result.part	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())