{
  "resourceType": "StructureDefinition",
  "id": "PaymentNotice",
  "meta": {
    "lastUpdated": "2021-01-01T21:58:31.578+00:00"
  },
  "extension": [
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
      "valueString": "Financial.Payment"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
      "valueCode": "trial-use"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
      "valueInteger": 2
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
      "valueCode": "patient"
    },
    {
      "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode": "fm"
    },
    {
      "url": "http://hl7.org/fhir/build/StructureDefinition/entered-in-error-status",
      "valueCode": ".status = entered-in-error"
    }
  ],
  "url": "http://hl7.org/fhir/StructureDefinition/PaymentNotice",
  "version": "4.6.0",
  "name": "PaymentNotice",
  "status": "draft",
  "date": "2021-01-01T21:58:31+00:00",
  "publisher": "Health Level Seven International (Financial Management)",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.org/fhir"
        }
      ]
    },
    {
      "telecom": [
        {
          "system": "url",
          "value": "http://www.hl7.org/Special/committees/fm/index.cfm"
        }
      ]
    }
  ],
  "description": "This resource provides the status of the payment for goods and services rendered, and the request and response resource references.",
  "fhirVersion": "4.6.0",
  "mapping": [
    {
      "identity": "workflow",
      "uri": "http://hl7.org/fhir/workflow",
      "name": "Workflow Pattern"
    },
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    },
    {
      "identity": "w5",
      "uri": "http://hl7.org/fhir/fivews",
      "name": "FiveWs Pattern 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/DomainResource",
  "derivation": "specialization",
  "differential": {
    "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": "*",
        "mapping": [
          {
            "identity": "workflow",
            "map": "Event"
          },
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "w5",
            "map": "financial.payment"
          }
        ]
      },
      {
        "id": "PaymentNotice.identifier",
        "path": "PaymentNotice.identifier",
        "short": "Business Identifier for the payment noctice",
        "definition": "A unique identifier assigned to this payment notice.",
        "requirements": "Allows payment notices to be distinguished and referenced.",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Identifier"
          }
        ],
        "mapping": [
          {
            "identity": "workflow",
            "map": "Event.identifier"
          },
          {
            "identity": "w5",
            "map": "FiveWs.identifier"
          },
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "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.",
        "requirements": "Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ],
        "isModifier": true,
        "isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
        "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.",
          "valueSet": "http://hl7.org/fhir/ValueSet/fm-status"
        },
        "mapping": [
          {
            "identity": "workflow",
            "map": "Event.status"
          },
          {
            "identity": "w5",
            "map": "FiveWs.status"
          },
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "PaymentNotice.request",
        "path": "PaymentNotice.request",
        "short": "Request reference",
        "definition": "Reference of resource for which payment is being made.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Resource"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "workflow",
            "map": "Event.basedOn"
          },
          {
            "identity": "w5",
            "map": "FiveWs.subject[x]"
          },
          {
            "identity": "w5",
            "map": "FiveWs.subject"
          }
        ]
      },
      {
        "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",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Resource"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "w5",
            "map": "FiveWs.subject[x]"
          },
          {
            "identity": "rim",
            "map": "n/a"
          },
          {
            "identity": "w5",
            "map": "FiveWs.subject"
          }
        ]
      },
      {
        "id": "PaymentNotice.created",
        "path": "PaymentNotice.created",
        "short": "Creation date",
        "definition": "The date when this resource was created.",
        "requirements": "Need to record a timestamp for use by both the recipient and the issuer.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "workflow",
            "map": "Event.occurrence[x]"
          },
          {
            "identity": "w5",
            "map": "FiveWs.recorded"
          },
          {
            "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",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Practitioner",
              "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
              "http://hl7.org/fhir/StructureDefinition/Organization"
            ]
          }
        ],
        "mapping": [
          {
            "identity": "workflow",
            "map": "Event.performer"
          },
          {
            "identity": "w5",
            "map": "FiveWs.source"
          },
          {
            "identity": "cdanetv4",
            "map": "B01"
          },
          {
            "identity": "v2",
            "map": "B01"
          },
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "PaymentNotice.payment",
        "path": "PaymentNotice.payment",
        "short": "Payment reference",
        "definition": "A reference to the payment which is the subject of this notice.",
        "requirements": "Need to identify the actual payment.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/PaymentReconciliation"
            ]
          }
        ],
        "isSummary": true
      },
      {
        "id": "PaymentNotice.paymentDate",
        "path": "PaymentNotice.paymentDate",
        "short": "Payment or clearing date",
        "definition": "The date when the above payment action occurred.",
        "requirements": "Need to convey the date when the action being notified occurred.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "date"
          }
        ]
      },
      {
        "id": "PaymentNotice.payee",
        "path": "PaymentNotice.payee",
        "short": "Party being paid",
        "definition": "The party who will receive or has received payment that is the subject of this notification.",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Practitioner",
              "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
              "http://hl7.org/fhir/StructureDefinition/Organization"
            ]
          }
        ]
      },
      {
        "id": "PaymentNotice.recipient",
        "path": "PaymentNotice.recipient",
        "short": "Party being notified",
        "definition": "The party who is notified of the payment status.",
        "requirements": "Need to identified the recipient of the notification.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Organization"
            ]
          }
        ],
        "isSummary": true,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "PaymentNotice.amount",
        "path": "PaymentNotice.amount",
        "short": "Monetary amount of the payment",
        "definition": "The amount sent to the payee.",
        "requirements": "Provided for validation purposes.",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Money"
          }
        ],
        "isSummary": true
      },
      {
        "id": "PaymentNotice.paymentStatus",
        "path": "PaymentNotice.paymentStatus",
        "short": "Issued or cleared Status of the payment",
        "definition": "A code indicating whether payment has been sent or cleared.",
        "comment": "Typically paid: payment sent, cleared: payment received.",
        "requirements": "The purpose of the notification.",
        "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.",
          "valueSet": "http://hl7.org/fhir/ValueSet/payment-status"
        },
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      }
    ]
  }
}