Patient Identifier Cross-referencing for mobile (PIXm), published by IHE IT Infrastructure Technical Committee. This guide is not an authorized publication; it is the continuous build for version 3.0.5-current built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/IHE/ITI.PIXm/ and changes regularly. See the Directory of published versions

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

Resource Profile: IHE PIXm Query Parameters Out

The StructureDefinition defines the Output Parameters for the $ihe-pix operation

• Output: targetId, targetIdentifier

Usages:

• Examples for this Profile: Parameters/pixm-response-mohralice-red-all and Parameters/pixm-response-mohralice-red-to-blue

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for parameter	ΣC	0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1
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:targetId	ΣC	0..*	BackboneElement	Operation Parameter Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Fixed Value: targetId
value[x]	ΣC	1..1	Reference(Patient) {r}	If parameter is a data type
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
parameter:targetIdentifier	ΣC	0..*	BackboneElement	targetIdentifier Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Fixed Value: targetIdentifier
value[x]	ΣC	1..1	Identifier	If parameter is a data type
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(Organization)	When the assigning authority name is provided, the actor shall also populate the assigner.
display	Σ	1..1	string	When the assigning authority name is provided, the actor shall also populate the display attribute.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Parameters.parameter:targetIdentifier.​value[x].use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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:targetId, Parameters.parameter:targetIdentifier	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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
Slices for parameter		0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:targetId		0..*	BackboneElement	Operation Parameter
name		1..1	string	Name from the definition Fixed Value: targetId
value[x]		1..1	Reference(Patient) {r}	If parameter is a data type
reference		1..1	string	Literal reference, Relative, internal or absolute URL
parameter:targetIdentifier		0..*	BackboneElement	targetIdentifier
name		1..1	string	Name from the definition Fixed Value: targetIdentifier
value[x]		1..1	Identifier	If parameter is a data type
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
assigner		0..1	Reference(Organization)	When the assigning authority name is provided, the actor shall also populate the assigner.
display		1..1	string	When the assigning authority name is provided, the actor shall also populate the display attribute.
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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	ΣC	0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1
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:targetId	ΣC	0..*	BackboneElement	Operation Parameter Constraints: inv-1
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 Fixed Value: targetId
value[x]	ΣC	1..1	Reference(Patient) {r}	If parameter is a data type
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:targetIdentifier	ΣC	0..*	BackboneElement	targetIdentifier Constraints: inv-1
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 Fixed Value: targetIdentifier
value[x]	ΣC	1..1	Identifier	If parameter is a data type
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	When the assigning authority name is provided, the actor shall also populate the assigner.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	When the assigning authority name is provided, the actor shall also populate the display attribute.
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	Status	Usage	ValueSet	Version	Source
Parameters.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Parameters.parameter:targetId.​value[x].type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Parameters.parameter:targetIdentifier.​value[x].use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Parameters.parameter:targetIdentifier.​value[x].type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Parameters.parameter:targetIdentifier.​value[x].assigner.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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:targetId, Parameters.parameter:targetIdentifier	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: 0 element(6 nested mandatory elements)
Fixed: 2 elements

Slices

This structure defines the following Slices:

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

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
Slices for parameter	ΣC	0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1
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:targetId	ΣC	0..*	BackboneElement	Operation Parameter Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Fixed Value: targetId
value[x]	ΣC	1..1	Reference(Patient) {r}	If parameter is a data type
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
parameter:targetIdentifier	ΣC	0..*	BackboneElement	targetIdentifier Constraints: inv-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
name	Σ	1..1	string	Name from the definition Fixed Value: targetIdentifier
value[x]	ΣC	1..1	Identifier	If parameter is a data type
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
assigner	Σ	0..1	Reference(Organization)	When the assigning authority name is provided, the actor shall also populate the assigner.
display	Σ	1..1	string	When the assigning authority name is provided, the actor shall also populate the display attribute.
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
Parameters.parameter:targetIdentifier.​value[x].use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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:targetId, Parameters.parameter:targetIdentifier	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()))

Differential View

This structure is derived from Parameters

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
Parameters		0..*	Parameters	Operation Request or Response
Slices for parameter		0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name
parameter:targetId		0..*	BackboneElement	Operation Parameter
name		1..1	string	Name from the definition Fixed Value: targetId
value[x]		1..1	Reference(Patient) {r}	If parameter is a data type
reference		1..1	string	Literal reference, Relative, internal or absolute URL
parameter:targetIdentifier		0..*	BackboneElement	targetIdentifier
name		1..1	string	Name from the definition Fixed Value: targetIdentifier
value[x]		1..1	Identifier	If parameter is a data type
system		1..1	uri	The namespace for the identifier value
value		1..1	string	The value that is unique
assigner		0..1	Reference(Organization)	When the assigning authority name is provided, the actor shall also populate the assigner.
display		1..1	string	When the assigning authority name is provided, the actor shall also populate the display attribute.
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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	ΣC	0..*	BackboneElement	Operation Parameter Slice: Unordered, Open by value:name Constraints: inv-1
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:targetId	ΣC	0..*	BackboneElement	Operation Parameter Constraints: inv-1
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 Fixed Value: targetId
value[x]	ΣC	1..1	Reference(Patient) {r}	If parameter is a data type
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	1..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	0..1	string	Text alternative for the resource
resource	ΣC	0..1	Resource	If parameter is a whole resource
part	Σ	0..*	See parameter (Parameters)	Named part of a multi-part parameter
parameter:targetIdentifier	ΣC	0..*	BackboneElement	targetIdentifier Constraints: inv-1
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 Fixed Value: targetIdentifier
value[x]	ΣC	1..1	Identifier	If parameter is a data type
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
use	?!Σ	0..1	code	usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type	Σ	0..1	CodeableConcept	Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system	Σ	1..1	uri	The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value	Σ	1..1	string	The value that is unique Example General: 123456
period	Σ	0..1	Period	Time period when id is/was valid for use
assigner	Σ	0..1	Reference(Organization)	When the assigning authority name is provided, the actor shall also populate the assigner.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
reference	ΣC	0..1	string	Literal reference, Relative, internal or absolute URL
type	Σ	0..1	uri	Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier	Σ	0..1	Identifier	Logical reference, when literal reference is not known
display	Σ	1..1	string	When the assigning authority name is provided, the actor shall also populate the display attribute.
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	Status	Usage	ValueSet	Version	Source
Parameters.language	Base	preferred	Common Languages	📍4.0.1	FHIR Std.
Parameters.parameter:targetId.​value[x].type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.
Parameters.parameter:targetIdentifier.​value[x].use	Base	required	IdentifierUse	📍4.0.1	FHIR Std.
Parameters.parameter:targetIdentifier.​value[x].type	Base	extensible	IdentifierType	📍4.0.1	FHIR Std.
Parameters.parameter:targetIdentifier.​value[x].assigner.type	Base	extensible	ResourceType	📍4.0.1	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
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:targetId, Parameters.parameter:targetIdentifier	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: 0 element(6 nested mandatory elements)
Fixed: 2 elements

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