Patient Identifier Cross-referencing for mobile (PIXm)
3.0.4 - Trial-Implementation International flag

This page is part of the IHE Patient Identifier Cross-referencing for Mobile (v3.0.4: Publication) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Resource Profile: IHE PIXm Query Parameters Out

Official URL: https://profiles.ihe.net/ITI/PIXm/StructureDefinition/IHE.PIXm.Query.Parameters.Out Version: 3.0.4
Active as of 2024-02-22 Computable Name: PIXmQueryParametersOut

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

  • Output: targetId, targetIdentifier

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 0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:targetId 0..*BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: targetId
..... value[x] 1..1Reference(Patient) {r}If parameter is a data type
...... reference 1..1stringLiteral reference, Relative, internal or absolute URL
.... parameter:targetIdentifier 0..*BackboneElementtargetIdentifier
..... name 1..1stringName from the definition
Fixed Value: targetIdentifier
..... value[x] 1..1IdentifierIf parameter is a data type
...... system 1..1uriThe namespace for the identifier value
...... value 1..1stringThe value that is unique
...... assigner 0..1Reference(Organization)When the assigning authority name is provided, the actor shall also populate the assigner.
....... display 1..1stringWhen the assigning authority name is provided, the actor shall also populate the display attribute.

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 Σ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:targetId ΣC0..*BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Fixed Value: targetId
..... value[x] ΣC1..1Reference(Patient) {r}If parameter is a data type
...... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... parameter:targetIdentifier ΣC0..*BackboneElementtargetIdentifier
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Fixed Value: targetIdentifier
..... value[x] ΣC1..1IdentifierIf parameter is a data type
...... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

...... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value Σ1..1stringThe value that is unique
Example General: 123456
...... assigner Σ0..1Reference(Organization)When the assigning authority name is provided, the actor shall also populate the assigner.
....... display Σ1..1stringWhen the assigning authority name is provided, the actor shall also populate the display attribute.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.parameter:targetIdentifier.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... Slices for parameter Σ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:targetId ΣC0..*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 Σ1..1stringName from the definition
Fixed Value: targetId
..... value[x] ΣC1..1Reference(Patient) {r}If parameter is a data type
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ0..1stringText alternative for the resource
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:targetIdentifier ΣC0..*BackboneElementtargetIdentifier
..... 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
Fixed Value: targetIdentifier
..... value[x] ΣC1..1IdentifierIf parameter is a data type
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

...... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value Σ1..1stringThe value that is unique
Example General: 123456
...... period Σ0..1PeriodTime period when id is/was valid for use
...... assigner Σ0..1Reference(Organization)When the assigning authority name is provided, the actor shall also populate the assigner.
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ1..1stringWhen the assigning authority name is provided, the actor shall also populate the display attribute.
..... 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

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Parameters.parameter:targetId.value[x].typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Parameters.parameter:targetIdentifier.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Parameters.parameter:targetIdentifier.value[x].typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Parameters.parameter:targetIdentifier.value[x].assigner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types

This structure is derived from Parameters

Summary

Mandatory: 0 element (6 nested mandatory elements)
Fixed Value: 2 elements

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 0..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:targetId 0..*BackboneElementOperation Parameter
..... name 1..1stringName from the definition
Fixed Value: targetId
..... value[x] 1..1Reference(Patient) {r}If parameter is a data type
...... reference 1..1stringLiteral reference, Relative, internal or absolute URL
.... parameter:targetIdentifier 0..*BackboneElementtargetIdentifier
..... name 1..1stringName from the definition
Fixed Value: targetIdentifier
..... value[x] 1..1IdentifierIf parameter is a data type
...... system 1..1uriThe namespace for the identifier value
...... value 1..1stringThe value that is unique
...... assigner 0..1Reference(Organization)When the assigning authority name is provided, the actor shall also populate the assigner.
....... display 1..1stringWhen the assigning authority name is provided, the actor shall also populate the display attribute.

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 Σ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:targetId ΣC0..*BackboneElementOperation Parameter
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Fixed Value: targetId
..... value[x] ΣC1..1Reference(Patient) {r}If parameter is a data type
...... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
.... parameter:targetIdentifier ΣC0..*BackboneElementtargetIdentifier
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Fixed Value: targetIdentifier
..... value[x] ΣC1..1IdentifierIf parameter is a data type
...... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

...... system Σ1..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value Σ1..1stringThe value that is unique
Example General: 123456
...... assigner Σ0..1Reference(Organization)When the assigning authority name is provided, the actor shall also populate the assigner.
....... display Σ1..1stringWhen the assigning authority name is provided, the actor shall also populate the display attribute.

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.parameter:targetIdentifier.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard

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
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
... Slices for parameter Σ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:targetId ΣC0..*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 Σ1..1stringName from the definition
Fixed Value: targetId
..... value[x] ΣC1..1Reference(Patient) {r}If parameter is a data type
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣC1..1stringLiteral reference, Relative, internal or absolute URL
...... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

...... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
...... display Σ0..1stringText alternative for the resource
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:targetIdentifier ΣC0..*BackboneElementtargetIdentifier
..... 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
Fixed Value: targetIdentifier
..... value[x] ΣC1..1IdentifierIf parameter is a data type
...... id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

...... type Σ0..1CodeableConceptDescription 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..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value Σ1..1stringThe value that is unique
Example General: 123456
...... period Σ0..1PeriodTime period when id is/was valid for use
...... assigner Σ0..1Reference(Organization)When the assigning authority name is provided, the actor shall also populate the assigner.
....... id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣC0..1stringLiteral reference, Relative, internal or absolute URL
....... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

....... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
....... display Σ1..1stringWhen the assigning authority name is provided, the actor shall also populate the display attribute.
..... 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

PathConformanceValueSetURI
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Parameters.parameter:targetId.value[x].typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
Parameters.parameter:targetIdentifier.value[x].userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Parameters.parameter:targetIdentifier.value[x].typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
Parameters.parameter:targetIdentifier.value[x].assigner.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types

This structure is derived from Parameters

Summary

Mandatory: 0 element (6 nested mandatory elements)
Fixed Value: 2 elements

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron