FHIR IG analytics| Package | hl7.fhir.uv.xver-r4b.r3 |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-profile-PaymentNotice.json |
| FHIR Version | R3 |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition profile-PaymentNotice
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  PaymentNotice | 0..* | PaymentNotice | PaymentNotice request | |
  meta | ||||
   Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
   extension:meta | 0..1 | Meta | R4B: meta additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.meta | |
| text | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:text | 0..1 | (Complex) | R4B: text additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.text | |
| Slices for extension | 2..* | Extension | Extension Slice: Unordered, Open by value:url | |
 extension:provider | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: Responsible practitioner URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| extension:payment | 1..1 | Reference(Cross-version Profile for R4B.PaymentReconciliation for use in FHIR STU3(0.1.0) | PaymentReconciliation) | R4B: Payment reference (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.payment | |
| extension:payee | 0..1 | Reference(Cross-version Profile for R4B.Practitioner for use in FHIR STU3(0.1.0) | Practitioner | Cross-version Profile for R4B.PractitionerRole for use in FHIR STU3(0.1.0) | PractitionerRole | Cross-version Profile for R4B.Organization for use in FHIR STU3(0.1.0) | Organization) | R4B: Party being paid (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.payee | |
| extension:amount | 1..1 | Money | R4B: Monetary amount of the payment (new) URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.amount | |
| identifier | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:identifier | 0..* | Identifier | R4B: Business Identifier for the payment noctice additional types URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.identifier | |
| request | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:request | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: request additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| response | ||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:response | 0..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: response additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| target | ||||
| Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:recipient | 1..1 | ?gen-e1? [CanonicalType[http://hl7.org/fhir/StructureDefinition/alternate-reference]] | R4B: Party being notified additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "profile-PaymentNotice",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "fhir"
},
{
"extension": [
{
"url": "packageId",
"valueId": "hl7.fhir.uv.xver-r4b.r3"
},
{
"url": "version",
"valueString": "0.1.0"
}
],
"url": "http://hl7.org/fhir/StructureDefinition/package-source"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 0,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4b.r3"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueUri": "http://hl7.org/fhir/uv/xver/ImplementationGuide/hl7.fhir.uv.xver-r4b.r3"
}
]
}
}
],
"url": "http://hl7.org/fhir/4.3/StructureDefinition/profile-PaymentNotice",
"version": "0.1.0",
"name": "Profile_R4B_PaymentNotice_R3",
"title": "Cross-version Profile for R4B.PaymentNotice for use in FHIR STU3",
"status": "active",
"experimental": false,
"date": "2026-03-17T16:04:24.8642151-05:00",
"publisher": "FHIR Infrastructure",
"contact": [
{
"name": "FHIR Infrastructure",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description": "This cross-version profile allows R4B PaymentNotice content to be represented via FHIR STU3 PaymentNotice resources.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "3.0.2",
"mapping": [
{
"identity": "workflow",
"uri": "http://hl7.org/fhir/workflow",
"name": "Workflow Mapping"
},
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
},
{
"identity": "w5",
"uri": "http://hl7.org/fhir/w5",
"name": "W5 Mapping"
},
{
"identity": "cdanetv4",
"uri": "http://www.cda-adc.ca/en/services/cdanet/",
"name": "Canadian Dental Association eclaims standard"
},
{
"identity": "v2",
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping"
}
],
"kind": "resource",
"abstract": false,
"type": "PaymentNotice",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/PaymentNotice",
"derivation": "constraint",
"snapshot": {
"element": [
{
"id": "PaymentNotice",
"path": "PaymentNotice",
"short": "PaymentNotice request",
"definition": "This resource provides the status of the payment for goods and services rendered, and the request and response resource references.",
"min": 0,
"max": "*",
"base": {
"path": "PaymentNotice",
"min": 0,
"max": "*"
},
"constraint": [
{
"key": "dom-2",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain nested Resources",
"expression": "contained.contained.empty()",
"xpath": "not(parent::f:contained and f:contained)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-1",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL NOT contain any narrative",
"expression": "contained.text.empty()",
"xpath": "not(parent::f:contained and f:text)",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-4",
"severity": "error",
"human": "If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated",
"expression": "contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()",
"xpath": "not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
},
{
"key": "dom-3",
"severity": "error",
"human": "If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource",
"expression": "contained.where(('#'+id in %resource.descendants().reference).not()).empty()",
"xpath": "not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))",
"source": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}
],
"mapping": [
{
"identity": "rim",
"map": "Entity. Role, or Act"
},
{
"identity": "workflow",
"map": "Event"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "financial.payment"
}
]
},
{
"id": "PaymentNotice.id",
"path": "PaymentNotice.id",
"short": "Logical id of this artifact",
"definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.",
"comment": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "PaymentNotice.meta",
"path": "PaymentNotice.meta",
"short": "Metadata about the resource",
"definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.meta",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Meta"
}
],
"isSummary": true
},
{
"id": "PaymentNotice.meta.id",
"path": "PaymentNotice.meta.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PaymentNotice.meta.extension",
"path": "PaymentNotice.meta.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "PaymentNotice.meta.extension:meta",
"path": "PaymentNotice.meta.extension",
"sliceName": "meta",
"short": "R4B: meta additional types",
"definition": "R4B: `PaymentNotice.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)",
"comment": "Element `PaymentNotice.meta` is mapped to FHIR STU3 element `PaymentNotice.meta` as `SourceIsBroaderThanTarget`.\nThe mappings for `PaymentNotice.meta` do not cover the following types: Meta.\nThe mappings for `PaymentNotice.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.meta|0.1.0"
}
]
},
{
"id": "PaymentNotice.meta.versionId",
"path": "PaymentNotice.meta.versionId",
"short": "Version specific identifier",
"definition": "The version specific identifier, as it appears in the version portion of the URL. This values changes when the resource is created, updated, or deleted.",
"comment": "The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.versionId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"isSummary": true
},
{
"id": "PaymentNotice.meta.lastUpdated",
"path": "PaymentNotice.meta.lastUpdated",
"short": "When the resource version last changed",
"definition": "When the resource last changed - e.g. when the version changed.",
"comment": "This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant.",
"min": 0,
"max": "1",
"base": {
"path": "Meta.lastUpdated",
"min": 0,
"max": "1"
},
"type": [
{
"code": "instant"
}
],
"isSummary": true
},
{
"id": "PaymentNotice.meta.profile",
"path": "PaymentNotice.meta.profile",
"short": "Profiles this resource claims to conform to",
"definition": "A list of profiles (references to [StructureDefinition](http://hl7.org/fhir/STU3/structuredefinition.html#) resources) that this resource claims to conform to. The URL is a reference to [StructureDefinition.url](http://hl7.org/fhir/STU3/).",
"comment": "It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.profile",
"min": 0,
"max": "*"
},
"type": [
{
"code": "uri"
}
],
"isSummary": true
},
{
"id": "PaymentNotice.meta.security",
"path": "PaymentNotice.meta.security",
"short": "Security Labels applied to this resource",
"definition": "Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.",
"comment": "The security labels can be updated without changing the stated version of the resource The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.security",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SecurityLabels"
}
],
"strength": "extensible",
"description": "Security Labels from the Healthcare Privacy and Security Classification System.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/security-labels|3.0.2"
}
}
},
{
"id": "PaymentNotice.meta.tag",
"path": "PaymentNotice.meta.tag",
"short": "Tags applied to this resource",
"definition": "Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.",
"comment": "The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.",
"min": 0,
"max": "*",
"base": {
"path": "Meta.tag",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Coding"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Tags"
}
],
"strength": "example",
"description": "Codes that represent various types of tags, commonly workflow-related; e.g. \"Needs review by Dr. Jones\"",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/common-tags|3.0.2"
}
}
},
{
"id": "PaymentNotice.implicitRules",
"path": "PaymentNotice.implicitRules",
"short": "A set of rules under which this content was created",
"definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.",
"comment": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. \n\nThis element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.",
"min": 0,
"max": "1",
"base": {
"path": "Resource.implicitRules",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"isModifier": true,
"isSummary": true
},
{
"id": "PaymentNotice.language",
"path": "PaymentNotice.language",
"short": "Language of the resource content",
"definition": "The base language in which the resource is written.",
"comment": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).",
"min": 0,
"max": "1",
"base": {
"path": "Resource.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-maxValueSet",
"valueReference": {
"reference": "http://hl7.org/fhir/ValueSet/all-languages|3.0.2"
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "Language"
}
],
"strength": "extensible",
"description": "A human language.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/languages|3.0.2"
}
}
},
{
"id": "PaymentNotice.text",
"path": "PaymentNotice.text",
"short": "Text summary of the resource, for human interpretation",
"definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.",
"comment": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded in formation is added later.",
"alias": [
"narrative",
"html",
"xhtml",
"display"
],
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Narrative"
}
],
"condition": [
"dom-1"
],
"mapping": [
{
"identity": "rim",
"map": "Act.text?"
}
]
},
{
"id": "PaymentNotice.text.id",
"path": "PaymentNotice.text.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PaymentNotice.text.extension",
"path": "PaymentNotice.text.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "PaymentNotice.text.extension:text",
"path": "PaymentNotice.text.extension",
"sliceName": "text",
"short": "R4B: text additional types",
"definition": "R4B: `PaymentNotice.text` additional types (Narrative) additional types from child elements (div, status)",
"comment": "Element `PaymentNotice.text` is mapped to FHIR STU3 element `PaymentNotice.text` as `SourceIsBroaderThanTarget`.\nThe mappings for `PaymentNotice.text` do not cover the following types: Narrative.\nThe mappings for `PaymentNotice.text` do not cover the following types based on type expansion: div, status.\nContained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.text|0.1.0"
}
]
},
{
"id": "PaymentNotice.text.status",
"path": "PaymentNotice.text.status",
"short": "generated | extensions | additional | empty",
"definition": "The status of the narrative - whether it's entirely generated (from just the defined data or the extensions too), or whether a human authored it and it may contain additional data.",
"min": 1,
"max": "1",
"base": {
"path": "Narrative.status",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "NarrativeStatus"
}
],
"strength": "required",
"description": "The status of a resource narrative",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/narrative-status|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PaymentNotice.text.div",
"path": "PaymentNotice.text.div",
"short": "Limited xhtml content",
"definition": "The actual narrative content, a stripped down version of XHTML.",
"comment": "The contents of the html element are an XHTML fragment containing only the basic html formatting elements described in chapters 7-11 and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained stylesheets. The XHTML content may not contain a head, a body, external stylesheet references, scripts, forms, base/link/xlink, frames, iframes and objects.",
"min": 1,
"max": "1",
"base": {
"path": "Narrative.div",
"min": 1,
"max": "1"
},
"type": [
{
"code": "xhtml"
}
],
"constraint": [
{
"key": "txt-1",
"severity": "error",
"human": "The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes",
"expression": "htmlchecks()",
"xpath": "not(descendant-or-self::*[not(local-name(.)=('a', 'abbr', 'acronym', 'b', 'big', 'blockquote', 'br', 'caption', 'cite', 'code', 'col', 'colgroup', 'dd', 'dfn', 'div', 'dl', 'dt', 'em', 'h1', 'h2', 'h3', 'h4', 'h5', 'h6', 'hr', 'i', 'img', 'li', 'ol', 'p', 'pre', 'q', 'samp', 'small', 'span', 'strong', 'sub', 'sup', 'table', 'tbody', 'td', 'tfoot', 'th', 'thead', 'tr', 'tt', 'ul', 'var'))]) and not(descendant-or-self::*/@*[not(name(.)=('abbr', 'accesskey', 'align', 'alt', 'axis', 'bgcolor', 'border', 'cellhalign', 'cellpadding', 'cellspacing', 'cellvalign', 'char', 'charoff', 'charset', 'cite', 'class', 'colspan', 'compact', 'coords', 'dir', 'frame', 'headers', 'height', 'href', 'hreflang', 'hspace', 'id', 'lang', 'longdesc', 'name', 'nowrap', 'rel', 'rev', 'rowspan', 'rules', 'scope', 'shape', 'span', 'src', 'start', 'style', 'summary', 'tabindex', 'title', 'type', 'valign', 'value', 'vspace', 'width'))])",
"source": "http://hl7.org/fhir/StructureDefinition/PaymentNotice"
},
{
"key": "txt-2",
"severity": "error",
"human": "The narrative SHALL have some non-whitespace content",
"expression": "htmlchecks()",
"xpath": "descendant::text()[normalize-space(.)!=''] or descendant::h:img[@src]",
"source": "http://hl7.org/fhir/StructureDefinition/PaymentNotice"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PaymentNotice.contained",
"path": "PaymentNotice.contained",
"short": "Contained, inline Resources",
"definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.",
"comment": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.",
"alias": [
"inline resources",
"anonymous resources",
"contained resources"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.contained",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PaymentNotice.extension",
"path": "PaymentNotice.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 2,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "PaymentNotice.extension:provider",
"path": "PaymentNotice.extension",
"sliceName": "provider",
"short": "R4B: Responsible practitioner",
"definition": "R4B: `PaymentNotice.provider`",
"comment": "Element `PaymentNotice.provider` is mapped to FHIR STU3 element `PaymentNotice.provider` as `SourceIsBroaderThanTarget`.\nElement `PaymentNotice.provider` is mapped to FHIR STU3 element `PaymentNotice.organization` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `PaymentNotice.provider` with unmapped reference targets: Organization, Practitioner, PractitionerRole.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "PaymentNotice.extension:payment",
"path": "PaymentNotice.extension",
"sliceName": "payment",
"short": "R4B: Payment reference (new)",
"definition": "R4B: `PaymentNotice.payment` (new:Reference(PaymentReconciliation))",
"comment": "Element `PaymentNotice.payment` has a context of PaymentNotice based on following the parent source element upwards and mapping to `PaymentNotice`.\nElement `PaymentNotice.payment` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 1,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.payment|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "PaymentNotice.extension:payee",
"path": "PaymentNotice.extension",
"sliceName": "payee",
"short": "R4B: Party being paid (new)",
"definition": "R4B: `PaymentNotice.payee` (new:Reference(Practitioner,PractitionerRole,Organization))",
"comment": "Element `PaymentNotice.payee` has a context of PaymentNotice based on following the parent source element upwards and mapping to `PaymentNotice`.\nElement `PaymentNotice.payee` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.payee|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "PaymentNotice.extension:amount",
"path": "PaymentNotice.extension",
"sliceName": "amount",
"short": "R4B: Monetary amount of the payment (new)",
"definition": "R4B: `PaymentNotice.amount` (new:Money)",
"comment": "Element `PaymentNotice.amount` has a context of PaymentNotice based on following the parent source element upwards and mapping to `PaymentNotice`.\nElement `PaymentNotice.amount` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 1,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.amount|0.1.0"
}
],
"condition": [
"ele-1"
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() | (children().count() > id.count())",
"xpath": "@value|f:*|h:div",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false
},
{
"id": "PaymentNotice.modifierExtension",
"path": "PaymentNotice.modifierExtension",
"short": "Extensions that cannot be ignored",
"definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"isModifier": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PaymentNotice.identifier",
"path": "PaymentNotice.identifier",
"short": "Business Identifier",
"definition": "The notice business identifier.",
"min": 0,
"max": "*",
"base": {
"path": "PaymentNotice.identifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Identifier"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.identifier"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "id"
}
]
},
{
"id": "PaymentNotice.identifier.id",
"path": "PaymentNotice.identifier.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PaymentNotice.identifier.extension",
"path": "PaymentNotice.identifier.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "PaymentNotice.identifier.extension:identifier",
"path": "PaymentNotice.identifier.extension",
"sliceName": "identifier",
"short": "R4B: Business Identifier for the payment noctice additional types",
"definition": "R4B: `PaymentNotice.identifier` additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)",
"comment": "Element `PaymentNotice.identifier` is mapped to FHIR STU3 element `PaymentNotice.identifier` as `SourceIsBroaderThanTarget`.\nThe mappings for `PaymentNotice.identifier` do not cover the following types: Identifier.\nThe mappings for `PaymentNotice.identifier` do not cover the following types based on type expansion: assigner, period, system, type, use, value.",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.identifier|0.1.0"
}
]
},
{
"id": "PaymentNotice.identifier.use",
"path": "PaymentNotice.identifier.use",
"short": "usual | official | temp | secondary (If known)",
"definition": "The purpose of this identifier.",
"comment": "This is labeled as \"Is Modifier\" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.",
"requirements": "Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.use",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierUse"
}
],
"strength": "required",
"description": "Identifies the purpose for this identifier, if known .",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-use|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "N/A"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "PaymentNotice.identifier.type",
"path": "PaymentNotice.identifier.type",
"short": "Description of identifier",
"definition": "A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.",
"comment": "This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. \n\nWhere the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.",
"requirements": "Allows users to make use of identifiers when the identifier system is not known.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.type",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "IdentifierType"
}
],
"strength": "extensible",
"description": "A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/identifier-type|3.0.2"
}
},
"mapping": [
{
"identity": "v2",
"map": "CX.5"
},
{
"identity": "rim",
"map": "Role.code or implied by context"
}
]
},
{
"id": "PaymentNotice.identifier.system",
"path": "PaymentNotice.identifier.system",
"short": "The namespace for the identifier value",
"definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.",
"requirements": "There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.system",
"min": 0,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"example": [
{
"label": "General",
"valueUri": "http://www.acme.com/identifiers/patient"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / EI-2-4"
},
{
"identity": "rim",
"map": "II.root or Role.id.root"
},
{
"identity": "servd",
"map": "./IdentifierType"
}
]
},
{
"id": "PaymentNotice.identifier.value",
"path": "PaymentNotice.identifier.value",
"short": "The value that is unique",
"definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.",
"comment": "If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/STU3/extension-rendered-value.html).",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"example": [
{
"label": "General",
"valueString": "123456"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.1 / EI.1"
},
{
"identity": "rim",
"map": "II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)"
},
{
"identity": "servd",
"map": "./Value"
}
]
},
{
"id": "PaymentNotice.identifier.period",
"path": "PaymentNotice.identifier.period",
"short": "Time period when id is/was valid for use",
"definition": "Time period during which identifier is/was valid for use.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.period",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Period"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.7 + CX.8"
},
{
"identity": "rim",
"map": "Role.effectiveTime or implied by context"
},
{
"identity": "servd",
"map": "./StartDate and ./EndDate"
}
]
},
{
"id": "PaymentNotice.identifier.assigner",
"path": "PaymentNotice.identifier.assigner",
"short": "Organization that issued id (may be just text)",
"definition": "Organization that issued/manages the identifier.",
"comment": "The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.",
"min": 0,
"max": "1",
"base": {
"path": "Identifier.assigner",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"isSummary": true,
"mapping": [
{
"identity": "v2",
"map": "CX.4 / (CX.4,CX.9,CX.10)"
},
{
"identity": "rim",
"map": "II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper"
},
{
"identity": "servd",
"map": "./IdentifierIssuingAuthority"
}
]
},
{
"id": "PaymentNotice.status",
"path": "PaymentNotice.status",
"short": "active | cancelled | draft | entered-in-error",
"definition": "The status of the resource instance.",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"min": 0,
"max": "1",
"base": {
"path": "PaymentNotice.status",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"isModifier": true,
"isSummary": true,
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PaymentNoticeStatus"
}
],
"strength": "required",
"description": "A code specifying the state of the resource instance.",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/fm-status|3.0.2"
}
},
"mapping": [
{
"identity": "workflow",
"map": "Event.status"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "status"
}
]
},
{
"id": "PaymentNotice.request",
"path": "PaymentNotice.request",
"short": "Request reference",
"definition": "Reference of resource for which payment is being made.",
"min": 0,
"max": "1",
"base": {
"path": "PaymentNotice.request",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.basedOn"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "PaymentNotice.request.id",
"path": "PaymentNotice.request.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PaymentNotice.request.extension",
"path": "PaymentNotice.request.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "PaymentNotice.request.extension:request",
"path": "PaymentNotice.request.extension",
"sliceName": "request",
"short": "R4B: request additional types",
"definition": "R4B: `PaymentNotice.request` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `PaymentNotice.request` is mapped to FHIR STU3 element `PaymentNotice.request` as `SourceIsBroaderThanTarget`.\nThe mappings for `PaymentNotice.request` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `PaymentNotice.request` with unmapped reference targets: Resource.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "PaymentNotice.request.reference",
"path": "PaymentNotice.request.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PaymentNotice.request.identifier",
"path": "PaymentNotice.request.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "PaymentNotice.request.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "PaymentNotice.request.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PaymentNotice.response",
"path": "PaymentNotice.response",
"short": "Response reference",
"definition": "Reference of response to resource for which payment is being made.",
"min": 0,
"max": "1",
"base": {
"path": "PaymentNotice.response",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Resource"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "who.focus"
}
]
},
{
"id": "PaymentNotice.response.id",
"path": "PaymentNotice.response.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PaymentNotice.response.extension",
"path": "PaymentNotice.response.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "PaymentNotice.response.extension:response",
"path": "PaymentNotice.response.extension",
"sliceName": "response",
"short": "R4B: response additional types",
"definition": "R4B: `PaymentNotice.response` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `PaymentNotice.response` is mapped to FHIR STU3 element `PaymentNotice.response` as `SourceIsBroaderThanTarget`.\nThe mappings for `PaymentNotice.response` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `PaymentNotice.response` with unmapped reference targets: Resource.",
"min": 0,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "PaymentNotice.response.reference",
"path": "PaymentNotice.response.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PaymentNotice.response.identifier",
"path": "PaymentNotice.response.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "PaymentNotice.response.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "PaymentNotice.response.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PaymentNotice.statusDate",
"path": "PaymentNotice.statusDate",
"short": "Payment or clearing date",
"definition": "The date when the above payment action occurrred.",
"min": 0,
"max": "1",
"base": {
"path": "PaymentNotice.statusDate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "date"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "when.done"
}
]
},
{
"id": "PaymentNotice.created",
"path": "PaymentNotice.created",
"short": "Creation date",
"definition": "The date when this resource was created.",
"min": 0,
"max": "1",
"base": {
"path": "PaymentNotice.created",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.occurrence"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "when.recorded"
}
]
},
{
"id": "PaymentNotice.target",
"path": "PaymentNotice.target",
"short": "Insurer or Regulatory body",
"definition": "The Insurer who is target of the request.",
"min": 0,
"max": "1",
"base": {
"path": "PaymentNotice.target",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PaymentNotice.target.id",
"path": "PaymentNotice.target.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "PaymentNotice.target.extension",
"path": "PaymentNotice.target.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 1,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"id": "PaymentNotice.target.extension:recipient",
"path": "PaymentNotice.target.extension",
"sliceName": "recipient",
"short": "R4B: Party being notified additional types",
"definition": "R4B: `PaymentNotice.recipient` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `PaymentNotice.recipient` is mapped to FHIR STU3 element `PaymentNotice.target` as `SourceIsBroaderThanTarget`.\nThe mappings for `PaymentNotice.recipient` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `PaymentNotice.recipient` with unmapped reference targets: Organization.",
"min": 1,
"max": "1",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "PaymentNotice.target.reference",
"path": "PaymentNotice.target.reference",
"short": "Literal reference, Relative, internal or absolute URL",
"definition": "A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources.",
"comment": "Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure \"/[type]/[id]\" then it should be assumed that the reference is to a FHIR RESTful server.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"condition": [
"ref-1"
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PaymentNotice.target.identifier",
"path": "PaymentNotice.target.identifier",
"short": "Logical reference, when literal reference is not known",
"definition": "An identifier for the other resource. This is used when there is no way to reference the other resource directly, either because the entity is not available through a FHIR server, or because there is no way for the author of the resource to convert a known identifier to an actual location. There is no requirement that a Reference.identifier point to something that is actually exposed as a FHIR instance, but it SHALL point to a business concept that would be expected to be exposed as a FHIR instance, and that instance would need to be of a FHIR resource type allowed by the reference.",
"comment": "When an identifier is provided in place of a reference, any system processing the reference will only be able to resolve the identifier to a reference if it understands the business context in which the identifier is used. Sometimes this is global (e.g. a national identifier) but often it is not. For this reason, none of the useful mechanisms described for working with references (e.g. chaining, includes) are possible, nor should servers be expected to be able resolve the reference. Servers may accept an identifier based reference untouched, resolve it, and/or reject it - see CapabilityStatement.rest.resource.referencePolicy. \n\nWhen both an identifier and a literal reference are provided, the literal reference is preferred. Applications processing the resource are allowed - but not required - to check that the identifier matches the literal reference\n\nApplications converting a logical reference to a literal reference may choose to leave the logical reference present, or remove it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.identifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": ".identifier"
}
]
},
{
"id": "PaymentNotice.target.display",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-translatable",
"valueBoolean": true
}
],
"path": "PaymentNotice.target.display",
"short": "Text alternative for the resource",
"definition": "Plain text narrative that identifies the resource in addition to the resource reference.",
"comment": "This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.display",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "PaymentNotice.provider",
"path": "PaymentNotice.provider",
"short": "Responsible practitioner",
"definition": "The practitioner who is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"base": {
"path": "PaymentNotice.provider",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Practitioner"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.performer.actor"
},
{
"identity": "cdanetv4",
"map": "B01"
},
{
"identity": "v2",
"map": "B01"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "PaymentNotice.organization",
"path": "PaymentNotice.organization",
"short": "Responsible organization",
"definition": "The organization which is responsible for the services rendered to the patient.",
"min": 0,
"max": "1",
"base": {
"path": "PaymentNotice.organization",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": "http://hl7.org/fhir/StructureDefinition/Organization"
}
],
"mapping": [
{
"identity": "workflow",
"map": "Event.performer.onBehalfOf"
},
{
"identity": "cdanetv4",
"map": "B02"
},
{
"identity": "v2",
"map": "B02"
},
{
"identity": "rim",
"map": "n/a"
},
{
"identity": "w5",
"map": "who.source"
}
]
},
{
"id": "PaymentNotice.paymentStatus",
"path": "PaymentNotice.paymentStatus",
"short": "Whether payment has been sent or cleared",
"definition": "The payment status, typically paid: payment sent, cleared: payment received.",
"min": 0,
"max": "1",
"base": {
"path": "PaymentNotice.paymentStatus",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "PaymentStatus"
}
],
"strength": "example",
"description": "The payment conveyance status codes",
"valueSetReference": {
"reference": "http://hl7.org/fhir/ValueSet/payment-status|3.0.2"
}
},
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
}
]
},
"differential": {
"element": [
{
"id": "PaymentNotice",
"path": "PaymentNotice"
},
{
"id": "PaymentNotice.meta.extension",
"path": "PaymentNotice.meta.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "PaymentNotice.meta.extension:meta",
"path": "PaymentNotice.meta.extension",
"sliceName": "meta",
"short": "R4B: meta additional types",
"definition": "R4B: `PaymentNotice.meta` additional types (Meta) additional types from child elements (lastUpdated, profile, security, source, tag, versionId)",
"comment": "Element `PaymentNotice.meta` is mapped to FHIR STU3 element `PaymentNotice.meta` as `SourceIsBroaderThanTarget`.\nThe mappings for `PaymentNotice.meta` do not cover the following types: Meta.\nThe mappings for `PaymentNotice.meta` do not cover the following types based on type expansion: lastUpdated, profile, security, source, tag, versionId.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.meta|0.1.0"
}
]
},
{
"id": "PaymentNotice.text.extension",
"path": "PaymentNotice.text.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "PaymentNotice.text.extension:text",
"path": "PaymentNotice.text.extension",
"sliceName": "text",
"short": "R4B: text additional types",
"definition": "R4B: `PaymentNotice.text` additional types (Narrative) additional types from child elements (div, status)",
"comment": "Element `PaymentNotice.text` is mapped to FHIR STU3 element `PaymentNotice.text` as `SourceIsBroaderThanTarget`.\nThe mappings for `PaymentNotice.text` do not cover the following types: Narrative.\nThe mappings for `PaymentNotice.text` do not cover the following types based on type expansion: div, status.\nContained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a \"text blob\" or where text is additionally entered raw or narrated and encoded information is added later.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.text|0.1.0"
}
]
},
{
"id": "PaymentNotice.extension",
"path": "PaymentNotice.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 2,
"max": "*"
},
{
"id": "PaymentNotice.extension:provider",
"path": "PaymentNotice.extension",
"sliceName": "provider",
"short": "R4B: Responsible practitioner",
"definition": "R4B: `PaymentNotice.provider`",
"comment": "Element `PaymentNotice.provider` is mapped to FHIR STU3 element `PaymentNotice.provider` as `SourceIsBroaderThanTarget`.\nElement `PaymentNotice.provider` is mapped to FHIR STU3 element `PaymentNotice.organization` as `SourceIsBroaderThanTarget`.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `PaymentNotice.provider` with unmapped reference targets: Organization, Practitioner, PractitionerRole.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "PaymentNotice.extension:payment",
"path": "PaymentNotice.extension",
"sliceName": "payment",
"short": "R4B: Payment reference (new)",
"definition": "R4B: `PaymentNotice.payment` (new:Reference(PaymentReconciliation))",
"comment": "Element `PaymentNotice.payment` has a context of PaymentNotice based on following the parent source element upwards and mapping to `PaymentNotice`.\nElement `PaymentNotice.payment` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 1,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.payment|0.1.0"
}
]
},
{
"id": "PaymentNotice.extension:payee",
"path": "PaymentNotice.extension",
"sliceName": "payee",
"short": "R4B: Party being paid (new)",
"definition": "R4B: `PaymentNotice.payee` (new:Reference(Practitioner,PractitionerRole,Organization))",
"comment": "Element `PaymentNotice.payee` has a context of PaymentNotice based on following the parent source element upwards and mapping to `PaymentNotice`.\nElement `PaymentNotice.payee` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.payee|0.1.0"
}
]
},
{
"id": "PaymentNotice.extension:amount",
"path": "PaymentNotice.extension",
"sliceName": "amount",
"short": "R4B: Monetary amount of the payment (new)",
"definition": "R4B: `PaymentNotice.amount` (new:Money)",
"comment": "Element `PaymentNotice.amount` has a context of PaymentNotice based on following the parent source element upwards and mapping to `PaymentNotice`.\nElement `PaymentNotice.amount` has no mapping targets in FHIR STU3. Typically, this is because the element has been added (is a new element).",
"min": 1,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.amount|0.1.0"
}
]
},
{
"id": "PaymentNotice.identifier.extension",
"path": "PaymentNotice.identifier.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "PaymentNotice.identifier.extension:identifier",
"path": "PaymentNotice.identifier.extension",
"sliceName": "identifier",
"short": "R4B: Business Identifier for the payment noctice additional types",
"definition": "R4B: `PaymentNotice.identifier` additional types (Identifier) additional types from child elements (assigner, period, system, type, use, value)",
"comment": "Element `PaymentNotice.identifier` is mapped to FHIR STU3 element `PaymentNotice.identifier` as `SourceIsBroaderThanTarget`.\nThe mappings for `PaymentNotice.identifier` do not cover the following types: Identifier.\nThe mappings for `PaymentNotice.identifier` do not cover the following types based on type expansion: assigner, period, system, type, use, value.",
"min": 0,
"max": "*",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/4.3/StructureDefinition/extension-PaymentNotice.identifier|0.1.0"
}
]
},
{
"id": "PaymentNotice.request.extension",
"path": "PaymentNotice.request.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "PaymentNotice.request.extension:request",
"path": "PaymentNotice.request.extension",
"sliceName": "request",
"short": "R4B: request additional types",
"definition": "R4B: `PaymentNotice.request` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `PaymentNotice.request` is mapped to FHIR STU3 element `PaymentNotice.request` as `SourceIsBroaderThanTarget`.\nThe mappings for `PaymentNotice.request` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `PaymentNotice.request` with unmapped reference targets: Resource.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "PaymentNotice.response.extension",
"path": "PaymentNotice.response.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 0,
"max": "*"
},
{
"id": "PaymentNotice.response.extension:response",
"path": "PaymentNotice.response.extension",
"sliceName": "response",
"short": "R4B: response additional types",
"definition": "R4B: `PaymentNotice.response` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `PaymentNotice.response` is mapped to FHIR STU3 element `PaymentNotice.response` as `SourceIsBroaderThanTarget`.\nThe mappings for `PaymentNotice.response` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `PaymentNotice.response` with unmapped reference targets: Resource.",
"min": 0,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
},
{
"id": "PaymentNotice.target.extension",
"path": "PaymentNotice.target.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"ordered": false,
"rules": "open"
},
"min": 1,
"max": "*"
},
{
"id": "PaymentNotice.target.extension:recipient",
"path": "PaymentNotice.target.extension",
"sliceName": "recipient",
"short": "R4B: Party being notified additional types",
"definition": "R4B: `PaymentNotice.recipient` additional types from child elements (display, identifier, reference, type)",
"comment": "Element `PaymentNotice.recipient` is mapped to FHIR STU3 element `PaymentNotice.target` as `SourceIsBroaderThanTarget`.\nThe mappings for `PaymentNotice.recipient` do not cover the following types based on type expansion: display, identifier, reference, type.\nThe standard extension `alternate-reference` has been mapped as the representation of FHIR R4B element `PaymentNotice.recipient` with unmapped reference targets: Organization.",
"min": 1,
"max": "1",
"base": {
"path": "DomainResource.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension",
"profile": "http://hl7.org/fhir/StructureDefinition/alternate-reference"
}
]
}
]
}
}