CH EPR FHIR (R4)
4.0.0-ballot - ballot Switzerland flag

This page is part of the CH EPR FHIR (R4) (v4.0.0-ballot: DSTU 4 Ballot 1) 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

Resource Profile: CH PIXm OUT Parameters

Official URL: http://fhir.ch/ig/ch-epr-fhir/StructureDefinition/ch-pixm-out-parameters Version: 4.0.0-ballot
Draft as of 2020-10-29 Computable Name: IHE_PIXm_OUT_Parameters_CH

Copyright/Legal: CC0-1.0

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

Usage:

Formal Views of Profile Content

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

This structure is derived from PIXmQueryParametersOut

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* PIXmQueryParametersOut Operation Request or Response
... Slices for parameter 0..3 BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:targetId 0..1 BackboneElement targetId
..... name 1..1 string Name from the definition
Fixed Value: targetId
..... valueReference 1..1 Reference(CH PDQm Patient) {r} If parameter is a data type
...... reference 1..1 string Absolute URL
.... parameter:targetIdentifier 0..2 BackboneElement targetIdentifier
..... name 1..1 string Name from the definition
Fixed Value: targetIdentifier
..... valueIdentifier 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

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* PIXmQueryParametersOut Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 0..3 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:targetId ΣC 0..1 BackboneElement targetId
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 Σ 1..1 string Name from the definition
Fixed Value: targetId
..... value[x] ΣC 1..1 Reference(CH PDQm Patient) {r} If parameter is a data type
...... reference ΣC 1..1 string Absolute URL
.... parameter:targetIdentifier ΣC 0..2 BackboneElement targetIdentifier
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 Σ 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

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

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:targetId, Parameters.parameter:targetIdentifierA 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()))
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* PIXmQueryParametersOut 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
... Slices for parameter ΣC 0..3 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:targetId ΣC 0..1 BackboneElement targetId
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 Σ 1..1 string Name from the definition
Fixed Value: targetId
..... value[x] ΣC 1..1 Reference(CH PDQm 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 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..2 BackboneElement targetIdentifier
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 Σ 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

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
from the FHIR Standard
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
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:targetId, Parameters.parameter:targetIdentifierA 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 PIXmQueryParametersOut

Summary

Fixed: 2 elements

Structures

This structure refers to these other structures:

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 PIXmQueryParametersOut

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* PIXmQueryParametersOut Operation Request or Response
... Slices for parameter 0..3 BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:targetId 0..1 BackboneElement targetId
..... name 1..1 string Name from the definition
Fixed Value: targetId
..... valueReference 1..1 Reference(CH PDQm Patient) {r} If parameter is a data type
...... reference 1..1 string Absolute URL
.... parameter:targetIdentifier 0..2 BackboneElement targetIdentifier
..... name 1..1 string Name from the definition
Fixed Value: targetIdentifier
..... valueIdentifier 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

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* PIXmQueryParametersOut Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 0..3 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:targetId ΣC 0..1 BackboneElement targetId
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 Σ 1..1 string Name from the definition
Fixed Value: targetId
..... value[x] ΣC 1..1 Reference(CH PDQm Patient) {r} If parameter is a data type
...... reference ΣC 1..1 string Absolute URL
.... parameter:targetIdentifier ΣC 0..2 BackboneElement targetIdentifier
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 Σ 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

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

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:targetId, Parameters.parameter:targetIdentifierA 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* PIXmQueryParametersOut 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
... Slices for parameter ΣC 0..3 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:targetId ΣC 0..1 BackboneElement targetId
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 Σ 1..1 string Name from the definition
Fixed Value: targetId
..... value[x] ΣC 1..1 Reference(CH PDQm 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 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..2 BackboneElement targetIdentifier
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 Σ 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

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
from the FHIR Standard
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
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
inv-1errorParameters.parameter, Parameters.parameter:targetId, Parameters.parameter:targetIdentifierA 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 PIXmQueryParametersOut

Summary

Fixed: 2 elements

Structures

This structure refers to these other structures:

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