CH EPR mHealth (R4)
3.0.0-ballot - ballot Switzerland flag

This page is part of the CH EPR mHealth (R4) (v3.0.0-ballot: Draft Ballot 1) based on FHIR 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-mhealth/StructureDefinition/ch-pixm-in-parameters Version: 3.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..*PIXmQueryParametersInOperation Request or Response
... Slices for parameter 1..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:sourceIdentifier 1..1BackboneElementsourceIdentifier
..... name 1..1stringName from the definition
Fixed Value: sourceIdentifier
..... valueIdentifier 1..1IdentifierIf parameter is a data type
...... system 1..1uriThe namespace for the identifier value
...... value 1..1stringThe value that is unique
.... parameter:targetSystem 1..2BackboneElementtargetSystem
..... name 1..1stringName from the definition
Fixed Value: targetSystem
..... valueUri 1..1uriIf parameter is a data type

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*PIXmQueryParametersInOperation Request or Response
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣC1..*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:sourceIdentifier ΣC1..1BackboneElementsourceIdentifier
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Fixed Value: sourceIdentifier
..... Slices for value[x] ΣC1..1IdentifierIf parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueIdentifier Σ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
.... parameter:targetSystem ΣC1..2BackboneElementtargetSystem
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Fixed Value: targetSystem
..... value[x] ΣC1..1uriIf parameter is a data type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Parameters.parameter:sourceIdentifier.value[x]:valueIdentifier.userequiredIdentifierUse

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..*PIXmQueryParametersInOperation 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
... Slices for parameter ΣC1..*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:sourceIdentifier ΣC1..1BackboneElementsourceIdentifier
..... 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: sourceIdentifier
..... Slices for value[x] ΣC1..1IdentifierIf parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueIdentifier Σ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)Organization that issued id (may be just text)
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:targetSystem ΣC1..2BackboneElementtargetSystem
..... 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: targetSystem
..... value[x] ΣC1..1uriIf parameter is a data type
..... 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

PathConformanceValueSet
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Parameters.parameter:sourceIdentifier.value[x]:valueIdentifier.userequiredIdentifierUse
Parameters.parameter:sourceIdentifier.value[x]:valueIdentifier.typeextensibleIdentifier Type Codes

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: 6 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 PIXmQueryParametersIn

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*PIXmQueryParametersInOperation Request or Response
... Slices for parameter 1..*BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:sourceIdentifier 1..1BackboneElementsourceIdentifier
..... name 1..1stringName from the definition
Fixed Value: sourceIdentifier
..... valueIdentifier 1..1IdentifierIf parameter is a data type
...... system 1..1uriThe namespace for the identifier value
...... value 1..1stringThe value that is unique
.... parameter:targetSystem 1..2BackboneElementtargetSystem
..... name 1..1stringName from the definition
Fixed Value: targetSystem
..... valueUri 1..1uriIf parameter is a data type

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*PIXmQueryParametersInOperation Request or Response
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... Slices for parameter ΣC1..*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:sourceIdentifier ΣC1..1BackboneElementsourceIdentifier
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Fixed Value: sourceIdentifier
..... Slices for value[x] ΣC1..1IdentifierIf parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueIdentifier Σ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
.... parameter:targetSystem ΣC1..2BackboneElementtargetSystem
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... name Σ1..1stringName from the definition
Fixed Value: targetSystem
..... value[x] ΣC1..1uriIf parameter is a data type

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
Parameters.parameter:sourceIdentifier.value[x]:valueIdentifier.userequiredIdentifierUse

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..*PIXmQueryParametersInOperation 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
... Slices for parameter ΣC1..*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:sourceIdentifier ΣC1..1BackboneElementsourceIdentifier
..... 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: sourceIdentifier
..... Slices for value[x] ΣC1..1IdentifierIf parameter is a data type
Slice: Unordered, Closed by type:$this
...... value[x]:valueIdentifier Σ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)Organization that issued id (may be just text)
..... resource ΣC0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:targetSystem ΣC1..2BackboneElementtargetSystem
..... 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: targetSystem
..... value[x] ΣC1..1uriIf parameter is a data type
..... 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

PathConformanceValueSet
Parameters.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Parameters.parameter:sourceIdentifier.value[x]:valueIdentifier.userequiredIdentifierUse
Parameters.parameter:sourceIdentifier.value[x]:valueIdentifier.typeextensibleIdentifier Type Codes

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: 6 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