Da Vinci Postable Remittance, published by HL7 International / Payer/Provider Information Exchange Work Group. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/davinci-pr/ and changes regularly. See the Directory of published versions
Official URL: http://hl7.org/fhir/us/davinci-pr/StructureDefinition/searchByPaymentParameters | Version: 1.0.0-ballot | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: SearchByPaymentParameters |
A profile of Parameters that indicate the incoming parameters for searching by a payment.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Parameters
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
Slices for parameter | 2..5 | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name | |
parameter:TIN | 1..1 | BackboneElement | Operation Parameter | |
name | 1..1 | string | Name from the definition Required Pattern: TIN | |
value[x] | 1..1 | string | If parameter is a data type | |
parameter:DateOfService | 0..1 | BackboneElement | Operation Parameter | |
name | 1..1 | string | Name from the definition Required Pattern: DateOfService | |
value[x] | 1..1 | Period | If parameter is a data type | |
parameter:PayerID | 0..1 | BackboneElement | Operation Parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PayerID | |
value[x] | 0..1 | string | If parameter is a data type | |
parameter:PayerName | 0..1 | BackboneElement | Operation Parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PayerName | |
value[x] | 0..1 | string | If parameter is a data type | |
parameter:PaymentInfo | 1..1 | BackboneElement | Operation Parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PaymentInfo | |
Slices for part | 2..5 | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||
part:PaymentIssueDate | 1..1 | BackboneElement | Named part of a multi-part parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PaymentIssueDate | |
value[x] | 1..1 | Period | If parameter is a data type | |
part:PaymentAmount | 0..1 | BackboneElement | Named part of a multi-part parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PaymentAmount | |
Slices for part | 2..2 | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||
part:PaymentAmountLow | 1..1 | BackboneElement | Named part of a multi-part parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PaymentAmountLow | |
value[x] | 1..1 | Money | If parameter is a data type | |
part:PaymentAmountHigh | 1..1 | BackboneElement | Named part of a multi-part parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PaymentAmountHigh | |
value[x] | 1..1 | Money | If parameter is a data type | |
part:PaymentNumber | 1..1 | BackboneElement | Named part of a multi-part parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PaymentNumber | |
value[x] | 1..1 | string | If parameter is a data type | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for parameter | ΣC | 2..5 | 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:TIN | ΣC | 1..1 | BackboneElement | Operation Parameter 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 Required Pattern: TIN |
value[x] | ΣC | 1..1 | string | If parameter is a data type |
parameter:DateOfService | ΣC | 0..1 | BackboneElement | Operation Parameter 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 Required Pattern: DateOfService |
value[x] | ΣC | 1..1 | Period | If parameter is a data type |
parameter:PayerID | ΣC | 0..1 | BackboneElement | Operation Parameter 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 Required Pattern: PayerID |
value[x] | ΣC | 0..1 | string | If parameter is a data type |
parameter:PayerName | ΣC | 0..1 | BackboneElement | Operation Parameter 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 Required Pattern: PayerName |
value[x] | ΣC | 0..1 | string | If parameter is a data type |
parameter:PaymentInfo | ΣC | 1..1 | BackboneElement | Operation Parameter 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 Required Pattern: PaymentInfo |
Slices for part | Σ | 2..5 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name |
part:PaymentIssueDate | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | Σ | 1..1 | string | Name from the definition Required Pattern: PaymentIssueDate |
value[x] | ΣC | 1..1 | Period | If parameter is a data type |
part:PaymentAmount | Σ | 0..1 | BackboneElement | Named part of a multi-part parameter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | Σ | 1..1 | string | Name from the definition Required Pattern: PaymentAmount |
Slices for part | Σ | 2..2 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name |
part:PaymentAmountLow | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | Σ | 1..1 | string | Name from the definition Required Pattern: PaymentAmountLow |
value[x] | ΣC | 1..1 | Money | If parameter is a data type |
part:PaymentAmountHigh | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | Σ | 1..1 | string | Name from the definition Required Pattern: PaymentAmountHigh |
value[x] | ΣC | 1..1 | Money | If parameter is a data type |
part:PaymentNumber | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | Σ | 1..1 | string | Name from the definition Required Pattern: PaymentNumber |
value[x] | ΣC | 1..1 | string | If parameter is a data type |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | Parameters.parameter, Parameters.parameter:TIN, Parameters.parameter:DateOfService, Parameters.parameter:PayerID, Parameters.parameter:PayerName, Parameters.parameter:PaymentInfo | A 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())) |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Parameters | 0..* | Parameters | 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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
Slices for parameter | ΣC | 2..5 | 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:TIN | ΣC | 1..1 | BackboneElement | Operation Parameter 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 Required Pattern: TIN | ||||
value[x] | ΣC | 1..1 | string | 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 | ||||
parameter:DateOfService | ΣC | 0..1 | BackboneElement | Operation Parameter 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 Required Pattern: DateOfService | ||||
value[x] | ΣC | 1..1 | Period | 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 | ||||
parameter:PayerID | ΣC | 0..1 | BackboneElement | Operation Parameter 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 Required Pattern: PayerID | ||||
value[x] | ΣC | 0..1 | string | 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 | ||||
parameter:PayerName | ΣC | 0..1 | BackboneElement | Operation Parameter 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 Required Pattern: PayerName | ||||
value[x] | ΣC | 0..1 | string | 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 | ||||
parameter:PaymentInfo | ΣC | 1..1 | BackboneElement | Operation Parameter 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 Required Pattern: PaymentInfo | ||||
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 | ||||
Slices for part | Σ | 2..5 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||||
part:PaymentIssueDate | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter | ||||
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 Required Pattern: PaymentIssueDate | ||||
value[x] | ΣC | 1..1 | Period | 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 | ||||
part:PaymentAmount | Σ | 0..1 | BackboneElement | Named part of a multi-part parameter | ||||
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 Required Pattern: PaymentAmount | ||||
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 | ||||
Slices for part | Σ | 2..2 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||||
part:PaymentAmountLow | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter | ||||
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 Required Pattern: PaymentAmountLow | ||||
value[x] | ΣC | 1..1 | Money | 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 | ||||
part:PaymentAmountHigh | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter | ||||
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 Required Pattern: PaymentAmountHigh | ||||
value[x] | ΣC | 1..1 | Money | 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 | ||||
part:PaymentNumber | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter | ||||
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 Required Pattern: PaymentNumber | ||||
value[x] | ΣC | 1..1 | string | 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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Parameters.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | Parameters.parameter, Parameters.parameter:TIN, Parameters.parameter:DateOfService, Parameters.parameter:PayerID, Parameters.parameter:PayerName, Parameters.parameter:PaymentInfo | A 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 Parameters
Summary
Mandatory: 7 elements(5 nested mandatory elements)
Slices
This structure defines the following Slices:
Maturity: 1
Differential View
This structure is derived from Parameters
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
Slices for parameter | 2..5 | BackboneElement | Operation Parameter Slice: Unordered, Open by value:name | |
parameter:TIN | 1..1 | BackboneElement | Operation Parameter | |
name | 1..1 | string | Name from the definition Required Pattern: TIN | |
value[x] | 1..1 | string | If parameter is a data type | |
parameter:DateOfService | 0..1 | BackboneElement | Operation Parameter | |
name | 1..1 | string | Name from the definition Required Pattern: DateOfService | |
value[x] | 1..1 | Period | If parameter is a data type | |
parameter:PayerID | 0..1 | BackboneElement | Operation Parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PayerID | |
value[x] | 0..1 | string | If parameter is a data type | |
parameter:PayerName | 0..1 | BackboneElement | Operation Parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PayerName | |
value[x] | 0..1 | string | If parameter is a data type | |
parameter:PaymentInfo | 1..1 | BackboneElement | Operation Parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PaymentInfo | |
Slices for part | 2..5 | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||
part:PaymentIssueDate | 1..1 | BackboneElement | Named part of a multi-part parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PaymentIssueDate | |
value[x] | 1..1 | Period | If parameter is a data type | |
part:PaymentAmount | 0..1 | BackboneElement | Named part of a multi-part parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PaymentAmount | |
Slices for part | 2..2 | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||
part:PaymentAmountLow | 1..1 | BackboneElement | Named part of a multi-part parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PaymentAmountLow | |
value[x] | 1..1 | Money | If parameter is a data type | |
part:PaymentAmountHigh | 1..1 | BackboneElement | Named part of a multi-part parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PaymentAmountHigh | |
value[x] | 1..1 | Money | If parameter is a data type | |
part:PaymentNumber | 1..1 | BackboneElement | Named part of a multi-part parameter | |
name | 1..1 | string | Name from the definition Required Pattern: PaymentNumber | |
value[x] | 1..1 | string | If parameter is a data type | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Parameters | 0..* | Parameters | Operation Request or Response | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for parameter | ΣC | 2..5 | 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:TIN | ΣC | 1..1 | BackboneElement | Operation Parameter 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 Required Pattern: TIN |
value[x] | ΣC | 1..1 | string | If parameter is a data type |
parameter:DateOfService | ΣC | 0..1 | BackboneElement | Operation Parameter 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 Required Pattern: DateOfService |
value[x] | ΣC | 1..1 | Period | If parameter is a data type |
parameter:PayerID | ΣC | 0..1 | BackboneElement | Operation Parameter 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 Required Pattern: PayerID |
value[x] | ΣC | 0..1 | string | If parameter is a data type |
parameter:PayerName | ΣC | 0..1 | BackboneElement | Operation Parameter 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 Required Pattern: PayerName |
value[x] | ΣC | 0..1 | string | If parameter is a data type |
parameter:PaymentInfo | ΣC | 1..1 | BackboneElement | Operation Parameter 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 Required Pattern: PaymentInfo |
Slices for part | Σ | 2..5 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name |
part:PaymentIssueDate | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | Σ | 1..1 | string | Name from the definition Required Pattern: PaymentIssueDate |
value[x] | ΣC | 1..1 | Period | If parameter is a data type |
part:PaymentAmount | Σ | 0..1 | BackboneElement | Named part of a multi-part parameter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | Σ | 1..1 | string | Name from the definition Required Pattern: PaymentAmount |
Slices for part | Σ | 2..2 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name |
part:PaymentAmountLow | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | Σ | 1..1 | string | Name from the definition Required Pattern: PaymentAmountLow |
value[x] | ΣC | 1..1 | Money | If parameter is a data type |
part:PaymentAmountHigh | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | Σ | 1..1 | string | Name from the definition Required Pattern: PaymentAmountHigh |
value[x] | ΣC | 1..1 | Money | If parameter is a data type |
part:PaymentNumber | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
name | Σ | 1..1 | string | Name from the definition Required Pattern: PaymentNumber |
value[x] | ΣC | 1..1 | string | If parameter is a data type |
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | Parameters.parameter, Parameters.parameter:TIN, Parameters.parameter:DateOfService, Parameters.parameter:PayerID, Parameters.parameter:PayerName, Parameters.parameter:PaymentInfo | A 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
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Parameters | 0..* | Parameters | 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 | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
Slices for parameter | ΣC | 2..5 | 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:TIN | ΣC | 1..1 | BackboneElement | Operation Parameter 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 Required Pattern: TIN | ||||
value[x] | ΣC | 1..1 | string | 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 | ||||
parameter:DateOfService | ΣC | 0..1 | BackboneElement | Operation Parameter 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 Required Pattern: DateOfService | ||||
value[x] | ΣC | 1..1 | Period | 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 | ||||
parameter:PayerID | ΣC | 0..1 | BackboneElement | Operation Parameter 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 Required Pattern: PayerID | ||||
value[x] | ΣC | 0..1 | string | 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 | ||||
parameter:PayerName | ΣC | 0..1 | BackboneElement | Operation Parameter 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 Required Pattern: PayerName | ||||
value[x] | ΣC | 0..1 | string | 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 | ||||
parameter:PaymentInfo | ΣC | 1..1 | BackboneElement | Operation Parameter 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 Required Pattern: PaymentInfo | ||||
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 | ||||
Slices for part | Σ | 2..5 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||||
part:PaymentIssueDate | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter | ||||
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 Required Pattern: PaymentIssueDate | ||||
value[x] | ΣC | 1..1 | Period | 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 | ||||
part:PaymentAmount | Σ | 0..1 | BackboneElement | Named part of a multi-part parameter | ||||
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 Required Pattern: PaymentAmount | ||||
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 | ||||
Slices for part | Σ | 2..2 | See parameter (Parameters) | Named part of a multi-part parameter Slice: Unordered, Open by value:name | ||||
part:PaymentAmountLow | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter | ||||
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 Required Pattern: PaymentAmountLow | ||||
value[x] | ΣC | 1..1 | Money | 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 | ||||
part:PaymentAmountHigh | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter | ||||
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 Required Pattern: PaymentAmountHigh | ||||
value[x] | ΣC | 1..1 | Money | 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 | ||||
part:PaymentNumber | Σ | 1..1 | BackboneElement | Named part of a multi-part parameter | ||||
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 Required Pattern: PaymentNumber | ||||
value[x] | ΣC | 1..1 | string | 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 | ||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Parameters.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
inv-1 | error | Parameters.parameter, Parameters.parameter:TIN, Parameters.parameter:DateOfService, Parameters.parameter:PayerID, Parameters.parameter:PayerName, Parameters.parameter:PaymentInfo | A 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 Parameters
Summary
Mandatory: 7 elements(5 nested mandatory elements)
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron