POST api/WebServiceClaim

Submit a claim

Request Information

URI Parameters

None.

Body Parameters

WebServiceClaim
NameDescriptionTypeAdditional information
ClaimAttachments

List of claim file attachments

Collection of ClaimAttachment

None.

AmountClaimed

The fee in units claimed by the Service Provider for the service rendered

string

DB Type: int

Required

AnaesMod1

Indicator of whether or not the anaesthesia modifier 1 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod10

Indicator of whether or not the anaesthesia modifier 10 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod11

Indicator of whether or not the anaesthesia modifier 11 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod12

Indicator of whether or not the anaesthesia modifier 12 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod13

Indicator of whether or not the anaesthesia modifier 13 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod14

Indicator of whether or not the anaesthesia modifier 14 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod15

Indicator of whether or not the anaesthesia modifier 15 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod16

Indicator of whether or not the anaesthesia modifier 16 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod2

Indicator of whether or not the anaesthesia modifier 2 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod3

Indicator of whether or not the anaesthesia modifier 3 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod4

Indicator of whether or not the anaesthesia modifier 4 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod5

Indicator of whether or not the anaesthesia modifier 5 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod6

Indicator of whether or not the anaesthesia modifier 6 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod7

Indicator of whether or not the anaesthesia modifier 7 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod8

Indicator of whether or not the anaesthesia modifier 8 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesMod9

Indicator of whether or not the anaesthesia modifier 9 is applied to the claim. For a list of anaesthetist modifiers eligible for submission refer to api/OpenDataGateway?name=ANAESTHETIST_MODIFIER

string

DB Type: bit

AnaesthesiaTime

The elapsed time on which the charge for anaesthesia is based with the starting point being the administration of the anaesthesia and ending when the patient is taken to the recovery room

string

DB Type: nvarchar(4)

Format: HHMM

CancelledSurgeryFlag

An indicator that the service claimed is a cancelled surgery claim

string

DB Type: bit

CancelledSurgeryReasonCode

Reason code associated with cancelled surgery

string

DB Type: nvarchar(9)

ClaimNo

Auto-generated number to uniquely identify a claim. This is not submitted by the source system, it is generated and provided on the response file by the MCE web service

string

None.

ClaimPayee

The account number to which the payment will be made/directed

string

DB Type: nvarchar(32)

Required

Comments

Further describe the service performed and/or to describe the document attached

string

DB Type: nvarchar(4000)

DateOfAdmission

The date on which the patient was admitted to the hospital

string

DB Type: datetime

Format: YYYYMMDD

DateOfDischarge

The date on which the patient was discharged from the hospital

string

DB Type: datetime

Format: YYYYMMDD

DateTaken

The date on which the service/procedure was performed. Example: The date on which the film was taken (Radiology)

string

DB Type: datetime

Format: YYYYMMDD

Diagnosis

The diagnosis of the patient receiving the service

string

DB Type: nvarchar(256)

Required

DiagnosisCode

The ICD10 CA diagnosis code. Up to 5 ICD10 CA codes can be submitted. Multiple Codes must be comma separated. MCE does not supply the ICD10 CA list. If needed, the list can be acquired from CIHI, and ICD10 CA codes must align with the version currently supported by the MCE/Medicare system.

string

DB Type: nvarchar(256)

EndDate

The date when the service provider completes delivery of a time based service. For a list of service codes that identify whether or not start/end date and time is required on the claim refer to api/OpenDataGateway?name=DATE_TIME_BASED_SERVICE_CODES (0 = Not required, 1 = Required)

string

DB Type: datetime

Format: YYYYMMDD

EndTime

The time of day when the service provider completes delivery of a time based service. For a list of service codes that identify whether or not start/end date and time is required on the claim refer to api/OpenDataGateway?name=DATE_TIME_BASED_SERVICE_CODES (0 = Not required, 1 = Required)

string

DB Type: nvarchar(4)

Format: HHMM

ExcludeFromFMNBFG

An indicator that the claim is to be excluded from FMNB assessment rules

string

DB Type: bit

ExternalSystemBatchId

Optionally allows EMR or Third Party program to group their claims

string

DB Type: nvarchar(255)

ExternalSystemClaimNumber

This number is not used by MCE it is there for the purpose of carrying claim number information that is of interest to the Third Party billing software. We expect that most billing software will use their own internal claim number in this field with the hope that billing systems can submit and reconcile claims using their own claim numbering system without regard to MCE claim numbering system.

string

DB Type: nvarchar(128)

ExternalSystemGroupId

Optionally allows an additional arbitrary grouping for clinic use

string

DB Type: nvarchar(255)

ExternalSystemOfficeId

Allows clinic to optionally identify a further distinction to specific offices (ex. one clinic, two offices, one in Bathurst, one in Fredericton)

string

DB Type: nvarchar(255)

ExternalSystemSoftware

Identifies the software of the EMR or Third Party program

string

DB Type: nvarchar(64)

Required

ExternalSystemSoftwareBuild

Identifies the compiled version of the EMR or Third party program

string

DB Type: nvarchar(64)

ExternalSystemSoftwareVer

Identifies the software version of the EMR or Third Party program

string

DB Type: nvarchar(64)

FMNBExclusionReason

Reason that the claim has been excluded from FMNB

string

DB Type: nvarchar(100)

FMNBProviderOffSiteFG

An indicator that the billing Provider was off-site at the time of service

string

DB Type: bit

HistoryFlag

An indicator that the service claimed is a shadow billing claim

string

DB Type: bit

IgnoreWarnings

If "True", claim is saved despite generated warnings from MCE

string

DB Type: bit

ImmunizationProductCode

Product Code of the vaccine given. For a list of Immunization Product codes (IMM_PRODUCT_CODE) eligible for submission refer to api/OpenDataGateway?name=IMMUNIZATION_PRODUCT

string

DB Type: nvarchar(16)

IsAfterHoursEmergency

And indicator that the After Hours Emergency premium is applied to a claim. Refer to IC Premium Indicator document for a description of the changes to the IC Premiums

string

DB Type: bit

IsCancerPremium

An indicator that the Cancer premium is applied to a claim. Refer to IC Premium Indicator document for a description of the changes to the IC Premiums

string

DB Type: bit

IsIndependentConsideration

An indicator that the independent consideration premium is applied to a claim. Refer to IC Premium Indicator document for a description of the changes to the IC Premiums

string

DB Type: bit

IsMidnightTo0600

An indicator that the midnight to 6:00 am premium is applied to a claim. Refer to IC Premium Indicator document for a description of the changes to the IC Premiums

string

DB Type: bit

LastDateCharged

The date the patient was last seen for services rendered over a period

string

DB Type: datetime

Format: YYYYMMDD

NewbornIdentifier

An identifier that determines the order in which baby was born first in case of twins / triplets/ etc. The expected values are a letter between A-J For unregistered newborn infants the identification number of the mother should be used, with the newborn’s complete date of birth and gender code M or F whichever is applicable, and a NewbornIdentifier until such time as the infant has been registered with Medicare. The alpha character of A or B or C, etc. is to be used to indicate either a single birth, twins or triplets, etc(e.g. for Triplets; Mother’s Medicare #/Baby’s date of birth, Gender M or F / Baby A ( first born) or B ( for second born) or C ( third born)

string

DB Type: nvarchar(4)

Required (for newborns)

OnCall

An indicator that the service being claimed was provided while the service provider was on call, rather than during their regular scheduled shift

string

DB Type: bit

IsORTE

OR Time Exception (ORTE). An indicator that the service being claimed is a non-emergency surgery done in the after-hours period, due to lack of available daytime operating room time or resources. This field is billed in conjunction with AHEP (IsAfterHoursEmergency OR IsMidnightTo700)

string

DB Type: bit

PatientFirstName

The patient's first name

string

DB Type: nvarchar(64)

Required (for non resident)

PatientLastName

The patient's last name

string

DB Type: nvarchar(64)

Required (for non resident)

PatientMiddleName

The patient's middle name

string

DB Type: nvarchar(64)

PhysicianRole

The role played by the Service Provider in the delivery of the service provided. i.e. role as a sugeon, assistant surgeon, anaesthetist. For a list of provider roles eligible for submission refer to api/OpenDataGateway?name=PROVIDER_ROLE

string

DB Type: nvarchar(16)

Required

PriorApprovalNumber

A System’s generated number resulting from a prior approval request submitted by a service provider to the department’s medical consultant for a decision re coverage of the service under Medicare

string

DB Type: nvarchar(32)

Province

The host province of the patient. For a list of provinces eligible for submission refer api/OpenDataGateway?name=PROVINCE

string

DB Type: nvarchar(2)

Required

Recipient

The patient's medicare number

string

DB Type: nvarchar(16)

Required

RecipientDOB

The patient’s date of birth

string

DB Type: datetime

Required

RecipientSex

The patient’s gender. For a list genders eligible for submission refer to api/OpenDataGateway?name=GENDER

string

DB Type: nvarchar(2)

Required

Referral

The referral’s service provider number when a patient has been referred to or referred from another physician. For a list of referring provider numbers eligible for submission refer to api/OpenDataGateway?name=REFERRING_SERVICE_PROVIDER

string

DB Type: nvarchar(16)

ReferralDate

The date on which the patient was referred to/from another service provider

string

DB Type: datetime

Format: YYYYMMDD

ReferralType

When a referral service provider number is present, this code indicates which situation prevailed. For a list of referral types eligible for submission refer to api/OpenDataGateway?name=REFERRAL_TYPE

string

DB Type: nvarchar(4)

RotationCode

The rotation code indicates that the billing service provider was covering a “mandated on call” shift. For a list of rotation codes eligible for submission refer to api/OpenDataGateway?name=VALID_ROTATIONS

string

DB Type: nvarchar(8)

BaseServiceCodeId

Primary code associated to the Service Code billed. Billed service code may require a a secondary "based on" service code in which the units are calculated against. To determine if the billed service code requires a based on service code, see the mapping table api/OpenDataGateway?name=SERVICE_BASE_CODE See the MCE-WS Integration Requirements Specification to determine how units are calculated using a based on service code.

string

DB Type: nvarchar(32)

ServiceCount

Total number of times that service is billed for on a claim

string

DB Type: int

Required

ServiceDate

The date on which the service was rendered

string

DB Type: datetime

Format: YYYYMMDD

Required

ServiceDescr

Description of the service code chosen. Specific service codes will require that the service description be overwritten. Specific service codes (888 and 75) will require the service description to be overwritten

string

DB Type: nvarchar(65)

ServiceLocation

The type of location where the service was rendered. i.e. Office, In Patient. For a list of service locations eligible for submission refer to api/OpenDataGateway?name=SERVICE_LOCATION_TYPE

string

DB Type: nvarchar(16)

Required

ServiceModifier

A numerical code used to qualify exact billing data re anatomical areas/locations (ex. Right vs Left, medial versus lateral) or surgical approaches (ex. Abdominal versus vaginal, thoracic versus abdominal), etc. for the purpose of applying accurate payment for multiple same day procedures/surgeries. For a list of service modifiers eligible for submission refer to api/OpenDataGateway?name=SERVICE_MODIFIER_TYPE

string

DB Type: nvarchar(32)

ServiceNoClaimed

The service code “billed” by the Service Provider for the service rendered. For a list of service codes eligible for submission refer to api/OpenDataGateway?name=SERVICE_CODE

string

DB Type: nvarchar(32)

Required

SiteNo

A number assigned to the actual building where the patient is receiving the services. For a list of medical sites eligible for submission refer to api/OpenDataGateway?name=MEDICAL_SITE

string

DB Type: nvarchar(16)

StartTime

The time of day when the service provider commences delivery of a time based service. For a list possible service codes that identify whether or not start/end date and time is required on the claim refer to api/OpenDataGateway?name=DATE_TIME_BASED_SERVICE_CODES (0 = Not required, 1 = Required)

string

DB Type: nvarchar(4)

Format: HHMM

VaccineLotNumber

The Lot number of the vaccine given for an immunization. For a list of vaccine lot number codes (VACCINE_LOT_CODE) eligible for submission refer to api/OpenDataGateway?name=VACCINE_LOT

string

DB Type: nvarchar(64)

ValidateOnly

Identifies if the claim is being validated as "edit only" claim., If "True", claim is not stored in MCE but will return validation results

string

DB Type: bit

Type: Boolean

Vendor

The service provider number that is billing for service

string

DB Type: nvarchar(16)

Required

IsMidnightTo0700

An indicator that the midnight to 7:00 am premium is applied to a claim. This field supersedes IsMidnightTo0600.

string

DB Type: bit

CheckForDuplicates

Indicates whether the claim should be checked against other claims containing the same external system claim number. AKA duplicate claim check.

string

DB Type: bit

Type: Boolean

Request Formats

application/json, text/json

Sample:
{
  "ClaimAttachments": [
    {
      "Attachment": "sample string 1",
      "Description": "sample string 2",
      "FileName": "sample string 3"
    },
    {
      "Attachment": "sample string 1",
      "Description": "sample string 2",
      "FileName": "sample string 3"
    }
  ],
  "AmountClaimed": "sample string 1",
  "AnaesMod1": "sample string 2",
  "AnaesMod10": "sample string 3",
  "AnaesMod11": "sample string 4",
  "AnaesMod12": "sample string 5",
  "AnaesMod13": "sample string 6",
  "AnaesMod14": "sample string 7",
  "AnaesMod15": "sample string 8",
  "AnaesMod16": "sample string 9",
  "AnaesMod2": "sample string 10",
  "AnaesMod3": "sample string 11",
  "AnaesMod4": "sample string 12",
  "AnaesMod5": "sample string 13",
  "AnaesMod6": "sample string 14",
  "AnaesMod7": "sample string 15",
  "AnaesMod8": "sample string 16",
  "AnaesMod9": "sample string 17",
  "AnaesthesiaTime": "sample string 18",
  "CancelledSurgeryFlag": "sample string 19",
  "CancelledSurgeryReasonCode": "sample string 20",
  "CCICode": "sample string 21",
  "ClaimNo": "sample string 22",
  "ClaimPayee": "sample string 23",
  "Comments": "sample string 24",
  "DateOfAdmission": "sample string 25",
  "DateOfDischarge": "sample string 26",
  "DateTaken": "sample string 27",
  "Diagnosis": "sample string 28",
  "DiagnosisCode": "sample string 29",
  "EndDate": "sample string 30",
  "EndTime": "sample string 31",
  "ExcludeFromFMNBFG": "sample string 32",
  "ExternalSystemBatchId": "sample string 33",
  "ExternalSystemClaimNumber": "sample string 34",
  "ExternalSystemGroupId": "sample string 35",
  "ExternalSystemOfficeId": "sample string 36",
  "ExternalSystemSoftware": "sample string 37",
  "ExternalSystemSoftwareBuild": "sample string 38",
  "ExternalSystemSoftwareVer": "sample string 39",
  "FMNBExclusionReason": "sample string 40",
  "FMNBProviderOffSiteFG": "sample string 41",
  "HistoryFlag": "sample string 42",
  "IgnoreWarnings": "sample string 43",
  "ImmunizationProductCode": "sample string 44",
  "IsAfterHoursEmergency": "sample string 45",
  "IsCancerPremium": "sample string 46",
  "IsIndependentConsideration": "sample string 47",
  "IsMidnightTo0600": "sample string 48",
  "LastDateCharged": "sample string 49",
  "NewbornIdentifier": "sample string 50",
  "OnCall": "sample string 51",
  "IsORTE": "sample string 52",
  "PatientFirstName": "sample string 53",
  "PatientLastName": "sample string 54",
  "PatientMiddleName": "sample string 55",
  "PhysicianRole": "sample string 56",
  "PriorApprovalNumber": "sample string 57",
  "Province": "sample string 58",
  "Recipient": "sample string 59",
  "RecipientDOB": "sample string 60",
  "RecipientSex": "sample string 61",
  "Referral": "sample string 62",
  "ReferralDate": "sample string 63",
  "ReferralType": "sample string 64",
  "RotationCode": "sample string 65",
  "BaseServiceCodeId": "sample string 66",
  "ServiceCount": "sample string 67",
  "ServiceDate": "sample string 68",
  "ServiceDescr": "sample string 69",
  "ServiceLocation": "sample string 70",
  "ServiceModifier": "sample string 71",
  "ServiceNoClaimed": "sample string 72",
  "SiteNo": "sample string 73",
  "StartTime": "sample string 74",
  "VaccineLotNumber": "sample string 75",
  "ValidateOnly": "sample string 76",
  "Vendor": "sample string 77",
  "IsMidnightTo0700": "sample string 78",
  "CheckForDuplicates": "sample string 79"
}

application/xml, text/xml

Sample:
<WebServiceClaim xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AmountClaimed>sample string 1</AmountClaimed>
  <AnaesMod1>sample string 2</AnaesMod1>
  <AnaesMod10>sample string 3</AnaesMod10>
  <AnaesMod11>sample string 4</AnaesMod11>
  <AnaesMod12>sample string 5</AnaesMod12>
  <AnaesMod13>sample string 6</AnaesMod13>
  <AnaesMod14>sample string 7</AnaesMod14>
  <AnaesMod15>sample string 8</AnaesMod15>
  <AnaesMod16>sample string 9</AnaesMod16>
  <AnaesMod2>sample string 10</AnaesMod2>
  <AnaesMod3>sample string 11</AnaesMod3>
  <AnaesMod4>sample string 12</AnaesMod4>
  <AnaesMod5>sample string 13</AnaesMod5>
  <AnaesMod6>sample string 14</AnaesMod6>
  <AnaesMod7>sample string 15</AnaesMod7>
  <AnaesMod8>sample string 16</AnaesMod8>
  <AnaesMod9>sample string 17</AnaesMod9>
  <AnaesthesiaTime>sample string 18</AnaesthesiaTime>
  <CancelledSurgeryFlag>sample string 19</CancelledSurgeryFlag>
  <CancelledSurgeryReasonCode>sample string 20</CancelledSurgeryReasonCode>
  <CCICode>sample string 21</CCICode>
  <ClaimNo>sample string 22</ClaimNo>
  <ClaimPayee>sample string 23</ClaimPayee>
  <Comments>sample string 24</Comments>
  <DateOfAdmission>sample string 25</DateOfAdmission>
  <DateOfDischarge>sample string 26</DateOfDischarge>
  <DateTaken>sample string 27</DateTaken>
  <Diagnosis>sample string 28</Diagnosis>
  <DiagnosisCode>sample string 29</DiagnosisCode>
  <EndDate>sample string 30</EndDate>
  <EndTime>sample string 31</EndTime>
  <ExcludeFromFMNBFG>sample string 32</ExcludeFromFMNBFG>
  <ExternalSystemBatchId>sample string 33</ExternalSystemBatchId>
  <ExternalSystemClaimNumber>sample string 34</ExternalSystemClaimNumber>
  <ExternalSystemGroupId>sample string 35</ExternalSystemGroupId>
  <ExternalSystemOfficeId>sample string 36</ExternalSystemOfficeId>
  <ExternalSystemSoftware>sample string 37</ExternalSystemSoftware>
  <ExternalSystemSoftwareBuild>sample string 38</ExternalSystemSoftwareBuild>
  <ExternalSystemSoftwareVer>sample string 39</ExternalSystemSoftwareVer>
  <FMNBExclusionReason>sample string 40</FMNBExclusionReason>
  <FMNBProviderOffSiteFG>sample string 41</FMNBProviderOffSiteFG>
  <HistoryFlag>sample string 42</HistoryFlag>
  <IgnoreWarnings>sample string 43</IgnoreWarnings>
  <ImmunizationProductCode>sample string 44</ImmunizationProductCode>
  <IsAfterHoursEmergency>sample string 45</IsAfterHoursEmergency>
  <IsCancerPremium>sample string 46</IsCancerPremium>
  <IsIndependentConsideration>sample string 47</IsIndependentConsideration>
  <IsMidnightTo0600>sample string 48</IsMidnightTo0600>
  <LastDateCharged>sample string 49</LastDateCharged>
  <NewbornIdentifier>sample string 50</NewbornIdentifier>
  <OnCall>sample string 51</OnCall>
  <IsORTE>sample string 52</IsORTE>
  <PatientFirstName>sample string 53</PatientFirstName>
  <PatientLastName>sample string 54</PatientLastName>
  <PatientMiddleName>sample string 55</PatientMiddleName>
  <PhysicianRole>sample string 56</PhysicianRole>
  <PriorApprovalNumber>sample string 57</PriorApprovalNumber>
  <Province>sample string 58</Province>
  <Recipient>sample string 59</Recipient>
  <RecipientDOB>sample string 60</RecipientDOB>
  <RecipientSex>sample string 61</RecipientSex>
  <Referral>sample string 62</Referral>
  <ReferralDate>sample string 63</ReferralDate>
  <ReferralType>sample string 64</ReferralType>
  <RotationCode>sample string 65</RotationCode>
  <BaseServiceCodeId>sample string 66</BaseServiceCodeId>
  <ServiceCount>sample string 67</ServiceCount>
  <ServiceDate>sample string 68</ServiceDate>
  <ServiceDescr>sample string 69</ServiceDescr>
  <ServiceLocation>sample string 70</ServiceLocation>
  <ServiceModifier>sample string 71</ServiceModifier>
  <ServiceNoClaimed>sample string 72</ServiceNoClaimed>
  <SiteNo>sample string 73</SiteNo>
  <StartTime>sample string 74</StartTime>
  <VaccineLotNumber>sample string 75</VaccineLotNumber>
  <ValidateOnly>sample string 76</ValidateOnly>
  <Vendor>sample string 77</Vendor>
  <IsMidnightTo0700>sample string 78</IsMidnightTo0700>
  <CheckForDuplicates>sample string 79</CheckForDuplicates>
  <ClaimAttachments>
    <ClaimAttachment>
      <Attachment>sample string 1</Attachment>
      <Description>sample string 2</Description>
      <FileName>sample string 3</FileName>
    </ClaimAttachment>
    <ClaimAttachment>
      <Attachment>sample string 1</Attachment>
      <Description>sample string 2</Description>
      <FileName>sample string 3</FileName>
    </ClaimAttachment>
  </ClaimAttachments>
</WebServiceClaim>

Response Information

Resource Description

SaveResult
NameDescriptionTypeAdditional information
Id

Unique response id

globally unique identifier

None.

Errors

List of errors

Collection of Error

None.

ClaimReceived

A receipt of the claim as received by MCE

WebServiceClaim

None.

Broadcasts

List of active broadcasts

Collection of Broadcast

None.

Response Formats

application/json, text/json

Sample:
{
  "Id": "59faa2cd-6ec3-4c60-a7db-1d78efa0402a",
  "Errors": [
    {
      "Property": "sample string 1",
      "Severity": 0,
      "SeverityStr": "Exception",
      "ShortMessageE": "sample string 2",
      "ShortMessageF": "sample string 3",
      "Code": "sample string 4",
      "LongMessageE": "sample string 5",
      "LongMessageF": "sample string 6"
    },
    {
      "Property": "sample string 1",
      "Severity": 0,
      "SeverityStr": "Exception",
      "ShortMessageE": "sample string 2",
      "ShortMessageF": "sample string 3",
      "Code": "sample string 4",
      "LongMessageE": "sample string 5",
      "LongMessageF": "sample string 6"
    }
  ],
  "ClaimReceived": {
    "ClaimAttachments": [
      {
        "Attachment": "sample string 1",
        "Description": "sample string 2",
        "FileName": "sample string 3"
      },
      {
        "Attachment": "sample string 1",
        "Description": "sample string 2",
        "FileName": "sample string 3"
      }
    ],
    "AmountClaimed": "sample string 1",
    "AnaesMod1": "sample string 2",
    "AnaesMod10": "sample string 3",
    "AnaesMod11": "sample string 4",
    "AnaesMod12": "sample string 5",
    "AnaesMod13": "sample string 6",
    "AnaesMod14": "sample string 7",
    "AnaesMod15": "sample string 8",
    "AnaesMod16": "sample string 9",
    "AnaesMod2": "sample string 10",
    "AnaesMod3": "sample string 11",
    "AnaesMod4": "sample string 12",
    "AnaesMod5": "sample string 13",
    "AnaesMod6": "sample string 14",
    "AnaesMod7": "sample string 15",
    "AnaesMod8": "sample string 16",
    "AnaesMod9": "sample string 17",
    "AnaesthesiaTime": "sample string 18",
    "CancelledSurgeryFlag": "sample string 19",
    "CancelledSurgeryReasonCode": "sample string 20",
    "CCICode": "sample string 21",
    "ClaimNo": "sample string 22",
    "ClaimPayee": "sample string 23",
    "Comments": "sample string 24",
    "DateOfAdmission": "sample string 25",
    "DateOfDischarge": "sample string 26",
    "DateTaken": "sample string 27",
    "Diagnosis": "sample string 28",
    "DiagnosisCode": "sample string 29",
    "EndDate": "sample string 30",
    "EndTime": "sample string 31",
    "ExcludeFromFMNBFG": "sample string 32",
    "ExternalSystemBatchId": "sample string 33",
    "ExternalSystemClaimNumber": "sample string 34",
    "ExternalSystemGroupId": "sample string 35",
    "ExternalSystemOfficeId": "sample string 36",
    "ExternalSystemSoftware": "sample string 37",
    "ExternalSystemSoftwareBuild": "sample string 38",
    "ExternalSystemSoftwareVer": "sample string 39",
    "FMNBExclusionReason": "sample string 40",
    "FMNBProviderOffSiteFG": "sample string 41",
    "HistoryFlag": "sample string 42",
    "IgnoreWarnings": "sample string 43",
    "ImmunizationProductCode": "sample string 44",
    "IsAfterHoursEmergency": "sample string 45",
    "IsCancerPremium": "sample string 46",
    "IsIndependentConsideration": "sample string 47",
    "IsMidnightTo0600": "sample string 48",
    "LastDateCharged": "sample string 49",
    "NewbornIdentifier": "sample string 50",
    "OnCall": "sample string 51",
    "IsORTE": "sample string 52",
    "PatientFirstName": "sample string 53",
    "PatientLastName": "sample string 54",
    "PatientMiddleName": "sample string 55",
    "PhysicianRole": "sample string 56",
    "PriorApprovalNumber": "sample string 57",
    "Province": "sample string 58",
    "Recipient": "sample string 59",
    "RecipientDOB": "sample string 60",
    "RecipientSex": "sample string 61",
    "Referral": "sample string 62",
    "ReferralDate": "sample string 63",
    "ReferralType": "sample string 64",
    "RotationCode": "sample string 65",
    "BaseServiceCodeId": "sample string 66",
    "ServiceCount": "sample string 67",
    "ServiceDate": "sample string 68",
    "ServiceDescr": "sample string 69",
    "ServiceLocation": "sample string 70",
    "ServiceModifier": "sample string 71",
    "ServiceNoClaimed": "sample string 72",
    "SiteNo": "sample string 73",
    "StartTime": "sample string 74",
    "VaccineLotNumber": "sample string 75",
    "ValidateOnly": "sample string 76",
    "Vendor": "sample string 77",
    "IsMidnightTo0700": "sample string 78",
    "CheckForDuplicates": "sample string 79"
  },
  "Broadcasts": [
    {
      "EffectiveDate": "2024-01-10T16:00:11.43792-04:00",
      "EffectiveTime": "sample string 1",
      "ExpiryDate": "2024-01-10T16:00:11.43792-04:00",
      "ExpiryTime": "sample string 2",
      "Id": "db51c1de-6d48-4c59-8f7f-afa9f0a50fd2",
      "MessageEN": "sample string 4",
      "MessageFR": "sample string 5",
      "Severity": "sample string 6",
      "TitleEN": "sample string 7",
      "TitleFR": "sample string 8"
    },
    {
      "EffectiveDate": "2024-01-10T16:00:11.43792-04:00",
      "EffectiveTime": "sample string 1",
      "ExpiryDate": "2024-01-10T16:00:11.43792-04:00",
      "ExpiryTime": "sample string 2",
      "Id": "db51c1de-6d48-4c59-8f7f-afa9f0a50fd2",
      "MessageEN": "sample string 4",
      "MessageFR": "sample string 5",
      "Severity": "sample string 6",
      "TitleEN": "sample string 7",
      "TitleFR": "sample string 8"
    }
  ]
}

application/xml, text/xml

Sample:
<SaveResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>59faa2cd-6ec3-4c60-a7db-1d78efa0402a</Id>
  <Errors>
    <Error>
      <Property>sample string 1</Property>
      <Severity>Exception</Severity>
      <ShortMessageE>sample string 2</ShortMessageE>
      <ShortMessageF>sample string 3</ShortMessageF>
      <Code>sample string 4</Code>
      <LongMessageE>sample string 5</LongMessageE>
      <LongMessageF>sample string 6</LongMessageF>
    </Error>
    <Error>
      <Property>sample string 1</Property>
      <Severity>Exception</Severity>
      <ShortMessageE>sample string 2</ShortMessageE>
      <ShortMessageF>sample string 3</ShortMessageF>
      <Code>sample string 4</Code>
      <LongMessageE>sample string 5</LongMessageE>
      <LongMessageF>sample string 6</LongMessageF>
    </Error>
  </Errors>
  <ClaimReceived>
    <AmountClaimed>sample string 1</AmountClaimed>
    <AnaesMod1>sample string 2</AnaesMod1>
    <AnaesMod10>sample string 3</AnaesMod10>
    <AnaesMod11>sample string 4</AnaesMod11>
    <AnaesMod12>sample string 5</AnaesMod12>
    <AnaesMod13>sample string 6</AnaesMod13>
    <AnaesMod14>sample string 7</AnaesMod14>
    <AnaesMod15>sample string 8</AnaesMod15>
    <AnaesMod16>sample string 9</AnaesMod16>
    <AnaesMod2>sample string 10</AnaesMod2>
    <AnaesMod3>sample string 11</AnaesMod3>
    <AnaesMod4>sample string 12</AnaesMod4>
    <AnaesMod5>sample string 13</AnaesMod5>
    <AnaesMod6>sample string 14</AnaesMod6>
    <AnaesMod7>sample string 15</AnaesMod7>
    <AnaesMod8>sample string 16</AnaesMod8>
    <AnaesMod9>sample string 17</AnaesMod9>
    <AnaesthesiaTime>sample string 18</AnaesthesiaTime>
    <CancelledSurgeryFlag>sample string 19</CancelledSurgeryFlag>
    <CancelledSurgeryReasonCode>sample string 20</CancelledSurgeryReasonCode>
    <CCICode>sample string 21</CCICode>
    <ClaimNo>sample string 22</ClaimNo>
    <ClaimPayee>sample string 23</ClaimPayee>
    <Comments>sample string 24</Comments>
    <DateOfAdmission>sample string 25</DateOfAdmission>
    <DateOfDischarge>sample string 26</DateOfDischarge>
    <DateTaken>sample string 27</DateTaken>
    <Diagnosis>sample string 28</Diagnosis>
    <DiagnosisCode>sample string 29</DiagnosisCode>
    <EndDate>sample string 30</EndDate>
    <EndTime>sample string 31</EndTime>
    <ExcludeFromFMNBFG>sample string 32</ExcludeFromFMNBFG>
    <ExternalSystemBatchId>sample string 33</ExternalSystemBatchId>
    <ExternalSystemClaimNumber>sample string 34</ExternalSystemClaimNumber>
    <ExternalSystemGroupId>sample string 35</ExternalSystemGroupId>
    <ExternalSystemOfficeId>sample string 36</ExternalSystemOfficeId>
    <ExternalSystemSoftware>sample string 37</ExternalSystemSoftware>
    <ExternalSystemSoftwareBuild>sample string 38</ExternalSystemSoftwareBuild>
    <ExternalSystemSoftwareVer>sample string 39</ExternalSystemSoftwareVer>
    <FMNBExclusionReason>sample string 40</FMNBExclusionReason>
    <FMNBProviderOffSiteFG>sample string 41</FMNBProviderOffSiteFG>
    <HistoryFlag>sample string 42</HistoryFlag>
    <IgnoreWarnings>sample string 43</IgnoreWarnings>
    <ImmunizationProductCode>sample string 44</ImmunizationProductCode>
    <IsAfterHoursEmergency>sample string 45</IsAfterHoursEmergency>
    <IsCancerPremium>sample string 46</IsCancerPremium>
    <IsIndependentConsideration>sample string 47</IsIndependentConsideration>
    <IsMidnightTo0600>sample string 48</IsMidnightTo0600>
    <LastDateCharged>sample string 49</LastDateCharged>
    <NewbornIdentifier>sample string 50</NewbornIdentifier>
    <OnCall>sample string 51</OnCall>
    <IsORTE>sample string 52</IsORTE>
    <PatientFirstName>sample string 53</PatientFirstName>
    <PatientLastName>sample string 54</PatientLastName>
    <PatientMiddleName>sample string 55</PatientMiddleName>
    <PhysicianRole>sample string 56</PhysicianRole>
    <PriorApprovalNumber>sample string 57</PriorApprovalNumber>
    <Province>sample string 58</Province>
    <Recipient>sample string 59</Recipient>
    <RecipientDOB>sample string 60</RecipientDOB>
    <RecipientSex>sample string 61</RecipientSex>
    <Referral>sample string 62</Referral>
    <ReferralDate>sample string 63</ReferralDate>
    <ReferralType>sample string 64</ReferralType>
    <RotationCode>sample string 65</RotationCode>
    <BaseServiceCodeId>sample string 66</BaseServiceCodeId>
    <ServiceCount>sample string 67</ServiceCount>
    <ServiceDate>sample string 68</ServiceDate>
    <ServiceDescr>sample string 69</ServiceDescr>
    <ServiceLocation>sample string 70</ServiceLocation>
    <ServiceModifier>sample string 71</ServiceModifier>
    <ServiceNoClaimed>sample string 72</ServiceNoClaimed>
    <SiteNo>sample string 73</SiteNo>
    <StartTime>sample string 74</StartTime>
    <VaccineLotNumber>sample string 75</VaccineLotNumber>
    <ValidateOnly>sample string 76</ValidateOnly>
    <Vendor>sample string 77</Vendor>
    <IsMidnightTo0700>sample string 78</IsMidnightTo0700>
    <CheckForDuplicates>sample string 79</CheckForDuplicates>
    <ClaimAttachments>
      <ClaimAttachment>
        <Attachment>sample string 1</Attachment>
        <Description>sample string 2</Description>
        <FileName>sample string 3</FileName>
      </ClaimAttachment>
      <ClaimAttachment>
        <Attachment>sample string 1</Attachment>
        <Description>sample string 2</Description>
        <FileName>sample string 3</FileName>
      </ClaimAttachment>
    </ClaimAttachments>
  </ClaimReceived>
  <Broadcasts>
    <Broadcast>
      <EffectiveDate>2024-01-10T16:00:11.43792-04:00</EffectiveDate>
      <EffectiveTime>sample string 1</EffectiveTime>
      <ExpiryDate>2024-01-10T16:00:11.43792-04:00</ExpiryDate>
      <ExpiryTime>sample string 2</ExpiryTime>
      <Id>db51c1de-6d48-4c59-8f7f-afa9f0a50fd2</Id>
      <MessageEN>sample string 4</MessageEN>
      <MessageFR>sample string 5</MessageFR>
      <Severity>sample string 6</Severity>
      <TitleEN>sample string 7</TitleEN>
      <TitleFR>sample string 8</TitleFR>
    </Broadcast>
    <Broadcast>
      <EffectiveDate>2024-01-10T16:00:11.43792-04:00</EffectiveDate>
      <EffectiveTime>sample string 1</EffectiveTime>
      <ExpiryDate>2024-01-10T16:00:11.43792-04:00</ExpiryDate>
      <ExpiryTime>sample string 2</ExpiryTime>
      <Id>db51c1de-6d48-4c59-8f7f-afa9f0a50fd2</Id>
      <MessageEN>sample string 4</MessageEN>
      <MessageFR>sample string 5</MessageFR>
      <Severity>sample string 6</Severity>
      <TitleEN>sample string 7</TitleEN>
      <TitleFR>sample string 8</TitleFR>
    </Broadcast>
  </Broadcasts>
</SaveResult>