Da Vinci Health Record Exchange (HRex)
0.2.0 - STU R1 - 2nd ballot

Da Vinci Health Record Exchange (HRex), published by HL7 International - Clinical Interoperability Council. 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/HL7/davinci-ehrx/ and changes regularly. See the Directory of published versions

Resource Profile: HRex Parameters - Member Match Response Profile

Defining URL:http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-parameters-member-match-out
Version:0.2.0
Name:HRexMemberMatchResponseParameters
Title:HRex Parameters - Member Match Response Profile
Status:Active as of 2021-11-10T00:11:05+00:00
Definition:

The Parameters profile for Da Vinci Find Member using Identifier datatype Response. The old health plan SHALL return the following data if records for member are found:

  • The unique member identifier (denoted through identifier parameter) submitted by the new health plan.
Publisher:HL7 International - Clinical Interoperability Council
Source Resource:XML / JSON / Turtle

The official URL for this profile is:

http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-parameters-member-match-out

Formal Views of Profile Content

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

This structure is derived from Parameters

Summary

Mandatory: 5 elements
Must-Support: 6 elements
Fixed Value: 1 element

Slices

This structure defines the following Slices:

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

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter S1..1BackboneElementOperation Parameter
Slice: Unordered, Closed by value:name
.... parameter:MemberIdentifier S1..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: MemberIdentifier
..... value[x] S1..1IdentifierIf parameter is a data type
...... type S1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
...... value S1..1stringThe value that is unique

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation 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 SΣI1..1BackboneElementOperation Parameter
Slice: Unordered, Closed 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:MemberIdentifier SΣI1..1BackboneElementOperation 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 SΣ1..1stringName from the definition
Fixed Value: MemberIdentifier
..... value[x] SΣ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 SΣ1..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.


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value SΣ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 ΣI0..1ResourceIf parameter is a whole resource
..... part Σ0..*See parameter (Parameters)Named part of a multi-part parameter

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter ΣI1..1BackboneElementOperation Parameter
Slice: Unordered, Closed by value:name
.... parameter:MemberIdentifier ΣI1..1BackboneElementOperation Parameter
..... name Σ1..1stringName from the definition
Fixed Value: MemberIdentifier
..... value[x] ΣI1..1IdentifierIf parameter is a data type
...... type Σ1..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.


Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
...... value Σ1..1stringThe value that is unique

doco Documentation for this format

This structure is derived from Parameters

Summary

Mandatory: 5 elements
Must-Support: 6 elements
Fixed Value: 1 element

Slices

This structure defines the following Slices:

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

Differential View

This structure is derived from Parameters

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation Request or Response
... Slices for parameter S1..1BackboneElementOperation Parameter
Slice: Unordered, Closed by value:name
.... parameter:MemberIdentifier S1..1BackboneElementOperation Parameter
..... name S1..1stringName from the definition
Fixed Value: MemberIdentifier
..... value[x] S1..1IdentifierIf parameter is a data type
...... type S1..1CodeableConceptDescription of identifier
Required Pattern: At least the following
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
...... value S1..1stringThe value that is unique

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Parameters 0..*ParametersOperation 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 SΣI1..1BackboneElementOperation Parameter
Slice: Unordered, Closed 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:MemberIdentifier SΣI1..1BackboneElementOperation 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 SΣ1..1stringName from the definition
Fixed Value: MemberIdentifier
..... value[x] SΣ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 SΣ1..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.


Required Pattern: At least the following
....... id0..1stringUnique id for inter-element referencing
....... extension0..*ExtensionAdditional content defined by implementations
....... coding1..*CodingCode defined by a terminology system
Fixed Value: (complex)
........ id0..1stringUnique id for inter-element referencing
........ extension0..*ExtensionAdditional content defined by implementations
........ system1..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
........ version0..1stringVersion of the system - if relevant
........ code1..1codeSymbol in syntax defined by the system
Fixed Value: MB
........ display0..1stringRepresentation defined by the system
........ userSelected0..1booleanIf this coding was chosen directly by the user
....... text0..1stringPlain text representation of the concept
...... system Σ0..1uriThe namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
...... value SΣ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 Σ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 / Code
Parameters.languagepreferredCommonLanguages
Max Binding: AllLanguages
Parameters.parameter:MemberIdentifier.value[x].userequiredIdentifierUse
Parameters.parameter:MemberIdentifier.value[x].typeextensiblePattern: MB

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:MemberIdentifierAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
inv-1Parameters.parameter:MemberIdentifierA 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:MemberIdentifier.extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter:MemberIdentifier.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter:MemberIdentifier.modifierExtensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter:MemberIdentifier.modifierExtensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter:MemberIdentifier.nameAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:MemberIdentifier.value[x]All FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:MemberIdentifier.value[x].extensionAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1Parameters.parameter:MemberIdentifier.value[x].extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Parameters.parameter:MemberIdentifier.value[x].useAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:MemberIdentifier.value[x].typeAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:MemberIdentifier.value[x].systemAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:MemberIdentifier.value[x].valueAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:MemberIdentifier.value[x].periodAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:MemberIdentifier.value[x].assignerAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ele-1Parameters.parameter:MemberIdentifier.partAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())