CH EPR mHealth (R4)
0.2.0 - DSTU 1 Informative Ballot

CH EPR mHealth (R4), published by eHealth Suisse. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/ehealthsuisse/ch-epr-mhealth/ and changes regularly. See the Directory of published versions

Resource Profile: CH PIXm OUT Parameters

Defining URL:http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-pixm-out-parameters
Version:0.2.0
Name:IHE_PIXm_OUT_Parameters_CH
Title:CH PIXm OUT Parameters
Status:Draft as of 10/29/20
Definition:

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

Publisher:eHealth Suisse
Copyright:

CC-BY-SA-4.0

Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://fhir.ch/ig/ch-epr-mhealth/StructureDefinition/ch-pixm-out-parameters

Formal Views of Profile Content

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

This structure is derived from PIXmQueryParametersOut

Summary

Fixed Value: 2 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

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

This structure is derived from PIXmQueryParametersOut

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*PIXmQueryParametersOutOperation Request or Response
... Slices for parameter 0..3BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:targetId 0..1BackboneElementtargetId
..... name 1..1stringName from the definition
Fixed Value: targetId
..... valueReference 1..1Reference(CH EPR mHealth Patient Profile for PIXm Mobile Patient Identity Feed) {r}If parameter is a data type
...... reference 1..1stringAbsolute URL
.... parameter:targetIdentifier 0..2BackboneElementtargetIdentifier
..... name 1..1stringName from the definition
Fixed Value: targetIdentifier
..... valueIdentifier 1..1IdentifierIf parameter is a data type
...... system 1..1uriThe namespace for the identifier value
...... value 1..1stringThe value that is unique

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*PIXmQueryParametersOutOperation Request or Response
... id Σ0..1stringLogical 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 ΣI0..3BackboneElementOperation 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] ΣI0..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 ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:targetId ΣI0..1BackboneElementtargetId
..... 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] ΣI1..1Reference(CH EPR mHealth Patient Profile for PIXm Mobile Patient Identity Feed) {r}If parameter is a data type
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI1..1stringAbsolute 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 ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:targetIdentifier ΣI0..2BackboneElementtargetIdentifier
..... 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] ΣI1..1IdentifierIf parameter is a data type
...... id 0..1stringUnique id for inter-element referencing
...... Slices for 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
....... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣI0..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 ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter

doco Documentation for this format

This structure is derived from PIXmQueryParametersOut

Summary

Fixed Value: 2 elements

Structures

This structure refers to these other structures:

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 PIXmQueryParametersOut

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*PIXmQueryParametersOutOperation Request or Response
... Slices for parameter 0..3BackboneElementOperation Parameter
Slice: Unordered, Open by value:name
.... parameter:targetId 0..1BackboneElementtargetId
..... name 1..1stringName from the definition
Fixed Value: targetId
..... valueReference 1..1Reference(CH EPR mHealth Patient Profile for PIXm Mobile Patient Identity Feed) {r}If parameter is a data type
...... reference 1..1stringAbsolute URL
.... parameter:targetIdentifier 0..2BackboneElementtargetIdentifier
..... name 1..1stringName from the definition
Fixed Value: targetIdentifier
..... valueIdentifier 1..1IdentifierIf parameter is a data type
...... system 1..1uriThe namespace for the identifier value
...... value 1..1stringThe value that is unique

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*PIXmQueryParametersOutOperation Request or Response
... id Σ0..1stringLogical 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 ΣI0..3BackboneElementOperation 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] ΣI0..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 ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:targetId ΣI0..1BackboneElementtargetId
..... 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] ΣI1..1Reference(CH EPR mHealth Patient Profile for PIXm Mobile Patient Identity Feed) {r}If parameter is a data type
...... id 0..1stringUnique id for inter-element referencing
...... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... reference ΣI1..1stringAbsolute 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 ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter
.... parameter:targetIdentifier ΣI0..2BackboneElementtargetIdentifier
..... 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] ΣI1..1IdentifierIf parameter is a data type
...... id 0..1stringUnique id for inter-element referencing
...... Slices for 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
....... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... reference ΣI0..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 ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Parameters.languagepreferredCommonLanguages
Max Binding: AllLanguages
Parameters.parameter:targetId.value[x].typeextensibleResourceType
Parameters.parameter:targetIdentifier.value[x].userequiredIdentifierUse
Parameters.parameter:targetIdentifier.value[x].typeextensibleIdentifier Type Codes
Parameters.parameter:targetIdentifier.value[x].assigner.typeextensibleResourceType

Constraints

IdPathDetailsRequirements
ele-1Parameters.metaAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.implicitRulesAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.languageAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameterAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1Parameters.parameterA 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()))
ele-1Parameters.parameter.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter.partAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetIdAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1Parameters.parameter:targetIdA 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()))
ele-1Parameters.parameter:targetId.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter:targetId.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter:targetId.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter:targetId.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter:targetId.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetId.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetId.value[x].extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter:targetId.value[x].extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter:targetId.value[x].referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetId.value[x].typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetId.value[x].identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetId.value[x].displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetId.partAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1Parameters.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()))
ele-1Parameters.parameter:targetIdentifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter:targetIdentifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter:targetIdentifier.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter:targetIdentifier.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter:targetIdentifier.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetIdentifier.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetIdentifier.value[x].extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter:targetIdentifier.value[x].extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter:targetIdentifier.value[x].useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetIdentifier.value[x].typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetIdentifier.value[x].systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetIdentifier.value[x].valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetIdentifier.value[x].periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetIdentifier.value[x].assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetIdentifier.value[x].assigner.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter:targetIdentifier.value[x].assigner.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter:targetIdentifier.value[x].assigner.referenceAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetIdentifier.value[x].assigner.typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetIdentifier.value[x].assigner.identifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetIdentifier.value[x].assigner.displayAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:targetIdentifier.partAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())