This page is part of the US Prescription Drug Monitoring Program (PDMP) (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) 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

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: PDMP Parameters - Response

This profile tailors the Parameters resource to convey PDMP History operation outputs.

Usage:

• Use this Resource Profile: PDMP Bundle - Response Message
• Examples for this Resource Profile: Parameters/pdmp-history-output-parameters-1, Parameters/pdmp-history-output-parameters-2-minimal-history, Parameters/pdmp-history-output-parameters-3-patient-not-found, Parameters/pdmp-history-output-parameters-4-link-response... Show 3 more, Parameters/pdmp-history-output-parameters-5-pre-stage-response, Parameters/pdmp-history-output-parameters-6-non-fatal-warning and Parameters/pdmp-history-output-parameters-7-fatal-error

Formal Views of Profile Content

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

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from Parameters

Name	Flags	Card.	Type	Description & Constraints
Parameters			Parameters
Slices for parameter	S	1..4	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:pdmp-history-data	S	0..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: pdmp-history-data
value[x]	S	0..1	Reference(PDMP Bundle - History Result)	If parameter is a data type
parameter:pdmp-history-link	S	0..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: pdmp-history-link
value[x]	S	0..1	url	If parameter is a data type
parameter:pre-stage-retrieval-key	S	0..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: pre-stage-retrieval-key
value[x]	S	0..1	string	If parameter is a data type
parameter:outcome	S	0..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: outcome
value[x]	S	0..1	Reference(OperationOutcome)	If parameter is a data type
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for parameter	SΣC	1..4	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition
parameter:pdmp-history-data	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: pdmp-history-data
value[x]	SΣC	0..1	Reference(PDMP Bundle - History Result)	If parameter is a data type
parameter:pdmp-history-link	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: pdmp-history-link
value[x]	SΣC	0..1	url	If parameter is a data type
parameter:pre-stage-retrieval-key	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: pre-stage-retrieval-key
value[x]	SΣC	0..1	string	If parameter is a data type
parameter:outcome	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: outcome
value[x]	SΣC	0..1	Reference(OperationOutcome)	If parameter is a data type
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-1	error	Parameters.parameter, Parameters.parameter:pdmp-history-data, Parameters.parameter:pdmp-history-link, Parameters.parameter:pre-stage-retrieval-key, Parameters.parameter:outcome	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()))

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
id	Σ	0..1	id	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): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for parameter	SΣC	1..4	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part)
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]	ΣC	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	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:pdmp-history-data	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
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: pdmp-history-data
value[x]	SΣC	0..1	Reference(PDMP Bundle - History Result)	If parameter is a data type
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:pdmp-history-link	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
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: pdmp-history-link
value[x]	SΣC	0..1	url	If parameter is a data type
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:pre-stage-retrieval-key	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
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: pre-stage-retrieval-key
value[x]	SΣC	0..1	string	If parameter is a data type
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:outcome	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
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: outcome
value[x]	SΣC	0..1	Reference(OperationOutcome)	If parameter is a data type
resource	ΣC	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

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-1	error	Parameters.parameter, Parameters.parameter:pdmp-history-data, Parameters.parameter:pdmp-history-link, Parameters.parameter:pre-stage-retrieval-key, Parameters.parameter:outcome	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()))

This structure is derived from Parameters

Summary

Mandatory: 1 element
Must-Support: 13 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

• PDMP Bundle - History Result (http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-bundle-history-result)

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Parameters

Name	Flags	Card.	Type	Description & Constraints
Parameters			Parameters
Slices for parameter	S	1..4	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:pdmp-history-data	S	0..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: pdmp-history-data
value[x]	S	0..1	Reference(PDMP Bundle - History Result)	If parameter is a data type
parameter:pdmp-history-link	S	0..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: pdmp-history-link
value[x]	S	0..1	url	If parameter is a data type
parameter:pre-stage-retrieval-key	S	0..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: pre-stage-retrieval-key
value[x]	S	0..1	string	If parameter is a data type
parameter:outcome	S	0..1	BackboneElement	Operation Parameter
name	S	1..1	string	Name from the definition Fixed Value: outcome
value[x]	S	0..1	Reference(OperationOutcome)	If parameter is a data type
Documentation for this format

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for parameter	SΣC	1..4	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part)
parameter:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition
parameter:pdmp-history-data	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: pdmp-history-data
value[x]	SΣC	0..1	Reference(PDMP Bundle - History Result)	If parameter is a data type
parameter:pdmp-history-link	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: pdmp-history-link
value[x]	SΣC	0..1	url	If parameter is a data type
parameter:pre-stage-retrieval-key	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: pre-stage-retrieval-key
value[x]	SΣC	0..1	string	If parameter is a data type
parameter:outcome	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	SΣ	1..1	string	Name from the definition Fixed Value: outcome
value[x]	SΣC	0..1	Reference(OperationOutcome)	If parameter is a data type
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-1	error	Parameters.parameter, Parameters.parameter:pdmp-history-data, Parameters.parameter:pdmp-history-link, Parameters.parameter:pre-stage-retrieval-key, Parameters.parameter:outcome	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()))

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Parameters		0..*	Parameters	Operation Request or Response
id	Σ	0..1	id	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): A human language. Additional Bindings Purpose AllLanguages Max Binding
Slices for parameter	SΣC	1..4	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name inv-1: A parameter must have one and only one of (value, resource, part)
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]	ΣC	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	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:pdmp-history-data	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
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: pdmp-history-data
value[x]	SΣC	0..1	Reference(PDMP Bundle - History Result)	If parameter is a data type
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:pdmp-history-link	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
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: pdmp-history-link
value[x]	SΣC	0..1	url	If parameter is a data type
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:pre-stage-retrieval-key	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
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: pre-stage-retrieval-key
value[x]	SΣC	0..1	string	If parameter is a data type
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:outcome	SΣC	0..1	BackboneElement	Operation Parameter inv-1: A parameter must have one and only one of (value, resource, part)
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: outcome
value[x]	SΣC	0..1	Reference(OperationOutcome)	If parameter is a data type
resource	ΣC	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

Terminology Bindings

Path	Conformance	ValueSet	URI
Parameters.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
inv-1	error	Parameters.parameter, Parameters.parameter:pdmp-history-data, Parameters.parameter:pdmp-history-link, Parameters.parameter:pre-stage-retrieval-key, Parameters.parameter:outcome	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()))

This structure is derived from Parameters

Summary

Mandatory: 1 element
Must-Support: 13 elements
Fixed: 4 elements

Structures

This structure refers to these other structures:

• PDMP Bundle - History Result (http://hl7.org/fhir/us/pdmp/StructureDefinition/pdmp-bundle-history-result)

Slices

This structure defines the following Slices:

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

Other representations of profile: CSV, Excel, Schematron