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 IN Parameters

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

Copyright/Legal: CC0-1.0

The StructureDefinition defines the Input Parameters for the $ihe-pix operation: - Input: sourceIdentifier, targetSystem

Usage:

Formal Views of Profile Content

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

This structure is derived from PIXmQueryParametersIn

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* PIXmQueryParametersIn Operation Request or Response
... Slices for parameter 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:sourceIdentifier 1..1 BackboneElement sourceIdentifier
..... name 1..1 string Name from the definition
Fixed Value: sourceIdentifier
..... 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
.... parameter:targetSystem 2..2 BackboneElement targetSystem
..... name 1..1 string Name from the definition
Fixed Value: targetSystem
..... valueUri 1..1 uri If parameter is a data type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* PIXmQueryParametersIn Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 1..* 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:sourceIdentifier ΣC 1..1 BackboneElement sourceIdentifier
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: sourceIdentifier
..... Slices for value[x] ΣC 1..1 Identifier If parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueIdentifier Σ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
.... parameter:targetSystem ΣC 2..2 BackboneElement targetSystem
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: targetSystem
..... Slices for value[x] ΣC 0..1 uri If parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueUri ΣC 1..1 uri If parameter is a data type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.parameter:sourceIdentifier.value[x]:valueIdentifier.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:sourceIdentifier, Parameters.parameter:targetSystemA 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..* PIXmQueryParametersIn 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 1..* 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:sourceIdentifier ΣC 1..1 BackboneElement sourceIdentifier
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: sourceIdentifier
..... Slices for value[x] ΣC 1..1 Identifier If parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueIdentifier Σ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) Organization that issued id (may be just text)
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:targetSystem ΣC 2..2 BackboneElement targetSystem
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: targetSystem
..... Slices for value[x] ΣC 0..1 uri If parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueUri ΣC 1..1 uri 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

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:sourceIdentifier.value[x]:valueIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Parameters.parameter:sourceIdentifier.value[x]:valueIdentifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
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:sourceIdentifier, Parameters.parameter:targetSystemA 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 PIXmQueryParametersIn

Summary

Mandatory: 5 elements
Fixed: 2 elements

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 PIXmQueryParametersIn

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* PIXmQueryParametersIn Operation Request or Response
... Slices for parameter 1..* BackboneElement Operation Parameter
Slice: Unordered, Open by value:name
.... parameter:sourceIdentifier 1..1 BackboneElement sourceIdentifier
..... name 1..1 string Name from the definition
Fixed Value: sourceIdentifier
..... 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
.... parameter:targetSystem 2..2 BackboneElement targetSystem
..... name 1..1 string Name from the definition
Fixed Value: targetSystem
..... valueUri 1..1 uri If parameter is a data type

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..* PIXmQueryParametersIn Operation Request or Response
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for parameter ΣC 1..* 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:sourceIdentifier ΣC 1..1 BackboneElement sourceIdentifier
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: sourceIdentifier
..... Slices for value[x] ΣC 1..1 Identifier If parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueIdentifier Σ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
.... parameter:targetSystem ΣC 2..2 BackboneElement targetSystem
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: targetSystem
..... Slices for value[x] ΣC 0..1 uri If parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueUri ΣC 1..1 uri If parameter is a data type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
Parameters.parameter:sourceIdentifier.value[x]:valueIdentifier.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:sourceIdentifier, Parameters.parameter:targetSystemA 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..* PIXmQueryParametersIn 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 1..* 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:sourceIdentifier ΣC 1..1 BackboneElement sourceIdentifier
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: sourceIdentifier
..... Slices for value[x] ΣC 1..1 Identifier If parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueIdentifier Σ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) Organization that issued id (may be just text)
..... resource ΣC 0..1 Resource If parameter is a whole resource
..... part Σ 0..* See parameter (Parameters) Named part of a multi-part parameter
.... parameter:targetSystem ΣC 2..2 BackboneElement targetSystem
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: targetSystem
..... Slices for value[x] ΣC 0..1 uri If parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueUri ΣC 1..1 uri 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

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:sourceIdentifier.value[x]:valueIdentifier.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
Parameters.parameter:sourceIdentifier.value[x]:valueIdentifier.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
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:sourceIdentifier, Parameters.parameter:targetSystemA 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 PIXmQueryParametersIn

Summary

Mandatory: 5 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