From 218135efda5ff7084dfafffb4ddcd8095ccdeaaa Mon Sep 17 00:00:00 2001 From: sam bacha Date: Wed, 22 Jul 2020 12:03:50 -0700 Subject: [PATCH] protocol spec 0.1.3 (#3) --- .gitattributes | 2 +- .gitignore | 2 + HEADER.yaml | 12 + ROOT/TypeMaps.json | 57 + SPEC/AS2.adoc | 27 + SPEC/MDN.adoc | 23 + abnf/Rule5010270.js | 254 + abnf/X12Service.grammar | 509 + abnf/abnf. | 14 + abnf/drafts.bill-of-lading.txt | 185 + abnf/drafts.txt | 43 + abnf/dtmf.abnf | 4 + abnf/rules.abnf | 32 + components/EventComponents.yaml | 22 + components/EventShippments.yaml | 84 + components/ReferenceVariables.yaml | 121 + components/equipmentEvent.yaml | 29 + components/shipmentEvent.yaml | 16 + components/transportEquipmentEvent.yaml | 37 + components/transportEvent.yaml | 32 + electronic_data_interchange.yaml | 20055 ++++++++++++++++ git_push.sh | 52 + lei-jsonld.json | 1770 ++ lei.json | 38 + lei/README.md | 106 + lib/freight/configuration.ts | 81 + lib/freight/events.service.ts | 156 + lib/freight/freight.module.ts | 35 + lib/freight/index.ts | 3 + lib/freight/ts/billOfLadingNumber.ts | 5 + lib/freight/ts/bookingReference.ts | 6 + lib/freight/ts/callbackUrl.ts | 6 + lib/freight/ts/emptyIndicatorCode.ts | 6 + lib/freight/ts/equipmentEvent.ts | 31 + lib/freight/ts/equipmentReference.ts | 6 + lib/freight/ts/error.ts | 26 + lib/freight/ts/errors.ts | 5 + lib/freight/ts/errorsInner.ts | 12 + lib/freight/ts/event.ts | 17 + lib/freight/ts/eventClassifierCode.ts | 6 + lib/freight/ts/eventDateTime.ts | 6 + lib/freight/ts/eventID.ts | 6 + lib/freight/ts/eventSubscription.ts | 16 + lib/freight/ts/eventSubscriptionBody.ts | 17 + lib/freight/ts/eventType.ts | 13 + lib/freight/ts/eventTypeCode.ts | 6 + lib/freight/ts/eventTypeList.ts | 8 + lib/freight/ts/events.ts | 12 + lib/freight/ts/facilityCode.ts | 6 + lib/freight/ts/facilityTypeCode.ts | 6 + lib/freight/ts/inlineResponse200.ts | 7 + lib/freight/ts/modeOfTransportCode.ts | 6 + lib/freight/ts/models.ts | 32 + lib/freight/ts/otherFacility.ts | 6 + lib/freight/ts/shipmentEvent.ts | 21 + lib/freight/ts/shipmentInformationTypeCode.ts | 6 + lib/freight/ts/subscriptionID.ts | 8 + lib/freight/ts/transportEquipmentEvent.ts | 37 + lib/freight/ts/transportEvent.ts | 33 + lib/freight/ts/transportLegReference.ts | 6 + lib/freight/ts/transportReference.ts | 6 + lib/freight/ts/uNLocationCode.ts | 6 + system/cascadingSchemes.yaml | 23 + system/commonParameters.yaml | 23 + system/multipleMimeTypes.yaml | 32 + system/operations/operationWithTags.yaml | 14 + .../stringPathAndBoolQueryParamResource.yaml | 12 + .../operations/stringPathParamResource.yaml | 12 + .../parameters/bodyComplexArrayParameter.yaml | 8 + system/parameters/bodyComplexParameter.yaml | 6 + system/parameters/bodyInt64Parameter.yaml | 7 + .../parameters/bodyStringArrayParameter.yaml | 7 + system/parameters/bodyStringParameter.yaml | 6 + .../parameters/formDataComplexParameter.yaml | 5 + system/parameters/formDataInt64Parameter.yaml | 6 + .../formDataStringArrayParameter.yaml | 7 + .../parameters/formDataStringParameter.yaml | 5 + .../parameters/headerInt64ArrayParameter.yaml | 9 + .../headerStringArrayParameter.yaml | 8 + system/parameters/headerStringParameter.yaml | 5 + system/parameters/pathInt64Parameter.yaml | 6 + .../parameters/pathStringArrayParameter.yaml | 8 + system/parameters/pathStringParameter.yaml | 5 + .../parameters/queryInt64ArrayParameter.yaml | 9 + system/parameters/queryStringParameter.yaml | 6 + .../parameters/queryWithComplexParameter.yaml | 6 + system/resourceWithExamplePayload.yaml | 23 + system/resourceWithLinkedDefinitions.yaml | 23 + .../resourceWithLinkedDefinitions_part1.yaml | 7 + system/resourceWithRelativeHost.yaml | 22 + system/reusableParameters.yaml | 26 + system/securityExample.yaml | 29 + system/stringPathParamResource.yaml | 23 + system/taggedResource.yaml | 29 + system/vendorExtensionExamples.yaml | 27 + trading_channel_credentials.jsonld | 48 + 96 files changed, 24688 insertions(+), 1 deletion(-) create mode 100644 .gitignore create mode 100644 HEADER.yaml create mode 100644 ROOT/TypeMaps.json create mode 100644 SPEC/AS2.adoc create mode 100644 SPEC/MDN.adoc create mode 100644 abnf/Rule5010270.js create mode 100644 abnf/X12Service.grammar create mode 100644 abnf/abnf. create mode 100644 abnf/drafts.bill-of-lading.txt create mode 100644 abnf/drafts.txt create mode 100644 abnf/dtmf.abnf create mode 100644 abnf/rules.abnf create mode 100644 components/EventComponents.yaml create mode 100644 components/EventShippments.yaml create mode 100644 components/ReferenceVariables.yaml create mode 100644 components/equipmentEvent.yaml create mode 100644 components/shipmentEvent.yaml create mode 100644 components/transportEquipmentEvent.yaml create mode 100644 components/transportEvent.yaml create mode 100644 electronic_data_interchange.yaml create mode 100644 git_push.sh create mode 100644 lei-jsonld.json create mode 100644 lei.json create mode 100644 lei/README.md create mode 100644 lib/freight/configuration.ts create mode 100644 lib/freight/events.service.ts create mode 100644 lib/freight/freight.module.ts create mode 100644 lib/freight/index.ts create mode 100644 lib/freight/ts/billOfLadingNumber.ts create mode 100644 lib/freight/ts/bookingReference.ts create mode 100644 lib/freight/ts/callbackUrl.ts create mode 100644 lib/freight/ts/emptyIndicatorCode.ts create mode 100644 lib/freight/ts/equipmentEvent.ts create mode 100644 lib/freight/ts/equipmentReference.ts create mode 100644 lib/freight/ts/error.ts create mode 100644 lib/freight/ts/errors.ts create mode 100644 lib/freight/ts/errorsInner.ts create mode 100644 lib/freight/ts/event.ts create mode 100644 lib/freight/ts/eventClassifierCode.ts create mode 100644 lib/freight/ts/eventDateTime.ts create mode 100644 lib/freight/ts/eventID.ts create mode 100644 lib/freight/ts/eventSubscription.ts create mode 100644 lib/freight/ts/eventSubscriptionBody.ts create mode 100644 lib/freight/ts/eventType.ts create mode 100644 lib/freight/ts/eventTypeCode.ts create mode 100644 lib/freight/ts/eventTypeList.ts create mode 100644 lib/freight/ts/events.ts create mode 100644 lib/freight/ts/facilityCode.ts create mode 100644 lib/freight/ts/facilityTypeCode.ts create mode 100644 lib/freight/ts/inlineResponse200.ts create mode 100644 lib/freight/ts/modeOfTransportCode.ts create mode 100644 lib/freight/ts/models.ts create mode 100644 lib/freight/ts/otherFacility.ts create mode 100644 lib/freight/ts/shipmentEvent.ts create mode 100644 lib/freight/ts/shipmentInformationTypeCode.ts create mode 100644 lib/freight/ts/subscriptionID.ts create mode 100644 lib/freight/ts/transportEquipmentEvent.ts create mode 100644 lib/freight/ts/transportEvent.ts create mode 100644 lib/freight/ts/transportLegReference.ts create mode 100644 lib/freight/ts/transportReference.ts create mode 100644 lib/freight/ts/uNLocationCode.ts create mode 100644 system/cascadingSchemes.yaml create mode 100644 system/commonParameters.yaml create mode 100644 system/multipleMimeTypes.yaml create mode 100644 system/operations/operationWithTags.yaml create mode 100644 system/operations/stringPathAndBoolQueryParamResource.yaml create mode 100644 system/operations/stringPathParamResource.yaml create mode 100644 system/parameters/bodyComplexArrayParameter.yaml create mode 100644 system/parameters/bodyComplexParameter.yaml create mode 100644 system/parameters/bodyInt64Parameter.yaml create mode 100644 system/parameters/bodyStringArrayParameter.yaml create mode 100644 system/parameters/bodyStringParameter.yaml create mode 100644 system/parameters/formDataComplexParameter.yaml create mode 100644 system/parameters/formDataInt64Parameter.yaml create mode 100644 system/parameters/formDataStringArrayParameter.yaml create mode 100644 system/parameters/formDataStringParameter.yaml create mode 100644 system/parameters/headerInt64ArrayParameter.yaml create mode 100644 system/parameters/headerStringArrayParameter.yaml create mode 100644 system/parameters/headerStringParameter.yaml create mode 100644 system/parameters/pathInt64Parameter.yaml create mode 100644 system/parameters/pathStringArrayParameter.yaml create mode 100644 system/parameters/pathStringParameter.yaml create mode 100644 system/parameters/queryInt64ArrayParameter.yaml create mode 100644 system/parameters/queryStringParameter.yaml create mode 100644 system/parameters/queryWithComplexParameter.yaml create mode 100644 system/resourceWithExamplePayload.yaml create mode 100644 system/resourceWithLinkedDefinitions.yaml create mode 100644 system/resourceWithLinkedDefinitions_part1.yaml create mode 100644 system/resourceWithRelativeHost.yaml create mode 100644 system/reusableParameters.yaml create mode 100644 system/securityExample.yaml create mode 100644 system/stringPathParamResource.yaml create mode 100644 system/taggedResource.yaml create mode 100644 system/vendorExtensionExamples.yaml create mode 100644 trading_channel_credentials.jsonld diff --git a/.gitattributes b/.gitattributes index f4a0ab2..930904c 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,5 +1,5 @@ *.sol linguist-language=Solidity -/* linguist-vendored +tests/* linguist-vendored *.js -linguist-vendored # see https://github.com/github/linguist/blob/master/lib/linguist/languages.yml#L64 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f17ebb8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ + +DEV/EDILib.js diff --git a/HEADER.yaml b/HEADER.yaml new file mode 100644 index 0000000..e2eca92 --- /dev/null +++ b/HEADER.yaml @@ -0,0 +1,12 @@ +freighttrust: +info: + version: "2.1.0" + title: 'Protocol specifications' + description: 'protocol values' + license: + name: Mozilla Public License 2.0 + url: hhttps://www.mozilla.org/en-US/MPL/2.0/ + contact: + name: Freight Trust and Clearing Corporation + url: https://freighttrust.com + email: protocol@freighttrust.com diff --git a/ROOT/TypeMaps.json b/ROOT/TypeMaps.json new file mode 100644 index 0000000..f96c83d --- /dev/null +++ b/ROOT/TypeMaps.json @@ -0,0 +1,57 @@ +[ + + + "@id": "http://spdx.org/licenses/MPL-2.0", + "@type": "spdx:License", + "isFsfLibre": "true", + "isOsiApproved": "true", + "licenseId": "MPL-2.0", + "#ref": "http://spdx.org/licenses/MPL-2.0", + "#type": "spdx:License", + "$id": "lei:254900C9UJMDGJ0ILK56", + "copyright": "2020 FreightTrust and Clearing Corporation", + "name": { + "@id": "X12 Grammar" + } + }, + { + + "TypeMaps": { + "TS204": "LoadTender", + "TS990": "LoadTenderResponse", + "TS997": "Acknowledgment", + "TS214": "LoadTenderStatus", + "TS210": "LoadTenderInvoice", + "S5": "Stop", + "B1": "BeginningSegmentPickupDelivery", + "B10": "BeginningSegment", + "L11": "ReferenceNumber", + "AT7": "ShipmentStatusDetails", + "MS1": "ShipmentLocationInfo", + "K1": "Remarks", + "Loop_S5_204": "Stops", + "N9": "Reference", + "AT5": "HandlingRequirement", + "Loop_N1_204": "Party", + "Loop_N7_204": "Equipment", + "LH6": "HazardousCertification", + "NTE": "Note", + "B3": "InvoiceInfo", + "G62": "DateTimeInfo", + "H3": "SpecialHandlingInstructions", + "N7": "EquipmentDetails", + "N1": "Name", + "LX": "AssignedNumber", + "L1": "RatesAndChargesInfo", + "L3": "TotalWeightAndChargesInfo", + "Loop_L1_210": "InvoiceRateChargeItem", + "Loop_LX_210": "InvoiceAssignedNumber", + "Loop_N1_210": "InvoiceName", + "Loop_N7_210": "InvoiceEquipmentDetail", + "Loop_S5_210": "InvoiceStop" + + } + } + } + +] \ No newline at end of file diff --git a/SPEC/AS2.adoc b/SPEC/AS2.adoc new file mode 100644 index 0000000..cf869ce --- /dev/null +++ b/SPEC/AS2.adoc @@ -0,0 +1,27 @@ +as2MessageId​ (String) - AS2 message ID + +persistedTimestamp​ (Long) - timestamp in milliseconds + +compressed​ (Boolean) - ​true​ or ​false​ depicting whether the AS2 message was compressed + +encrypted​ (Boolean) - ​true​ or ​false​ depicting whether the AS2 message was encrypted + +signed​ (Boolean) - ​true​ or ​false​ depicting whether the AS2 message was signed + +subject​ (String) - Subject of AS2 message. If there is no subject, this field will not be included in the response. + +receiverId​ (String) - AS2 ID of the AS2 partner who has sent/received this message + +senderId​ (String) - AS2 ID of the AS2 station which has received/sent this message + +transportStatusReceived​ (Integer, optional) - HTTP response code received. Only available on sent messages. + +deliveryStatus​ (String, optional) - AS2-level delivery status of the AS2 message. Only available on sent messages. Possible values are Delivered, Not Delivered and No Status. + +mdnStatus​ (String) - Delivery status of MDN. Possible values are Pending, Received, Not Requested and No MDN. + +partnerType​ (String) - AS2 Partner type. Possible values are Production and Test + +mdnMessage​ (​MDN Message​, optional) - represents the MDN sent/received for this AS2 message + +attachments​ (Array of ​Attachment​s) - the attachments sent/received in this AS2 message diff --git a/SPEC/MDN.adoc b/SPEC/MDN.adoc new file mode 100644 index 0000000..3e4886a --- /dev/null +++ b/SPEC/MDN.adoc @@ -0,0 +1,23 @@ +MDN Message + +Represents a receipt, i.e. disposition notification (MDN) message received/sent by AS2 Gateway, with the following attributes: + +persistedTimestamp​ (Long) - timestamp in milliseconds when the message was saved in AS2 Gateway + +mdnError​ (Boolean) - ​true​ or ​false​ depicting whether the received MDN is an error MDN or not + +content​ (String) - String with human readable part of the MDN received + +Attachment +Represents details of a single attachment sent/received by AS2 Gateway (usually appearing within a list of attachments), with the following attributes: + +name​​ (String) - attachment file name + +size​ (Integer) - size of the attachment in bytes + +Pagination +Represents a collection of entities (usually ​AS2 Message​s) returned from a pagination-enabled endpoint (usually a list endpoint) + +totalRecords​ (Integer) - the total number of results that match the query + +records​ (Array) - a subset of those results based on the requested ​pageOffset​ and ​pageLength diff --git a/abnf/Rule5010270.js b/abnf/Rule5010270.js new file mode 100644 index 0000000..e66154a --- /dev/null +++ b/abnf/Rule5010270.js @@ -0,0 +1,254 @@ +let Rule5010270 = "FILE DATA\n" + +"Version=005010X279A1\n" + +"Description=270 Eligibility, Coverage or Benefit Inquiry\n" + +"ELEMENT DEFINITIONS\n" + +"19=AN,2,30,City Name\n" + +"26=ID,2,3,Country Code\n" + +"28=NO,1,9,Group Control Number\n" + +"66=ID,1,2,Identification Code Qualifier\n" + +"67=AN,2,80,Identification Code\n" + +"93=AN,1,60,Name\n" + +"96=NO,1,10,Number of Included Segments\n" + +"97=NO,1,6,Number of Transaction Sets Included\n" + +"98=ID,2,3,Entity Identifier Code\n" + +"101=ID,2,2,Authorization Information Qualifier\n" + +"102=AN,10,10,Authorization Information\n" + +"103=ID,2,2,Security Information Qualifier\n" + +"104=AN,10,10,Security Information\n" + +"105=ID,2,2,Interchange ID Qualifier\n" + +"106=AN,15,15,Interchange Sender ID\n" + +"107=AN,15,15,Interchange Receiver ID\n" + +"108=DT,6,6,Interchange Date\n" + +"109=TM,4,4,Interchange Time\n" + +"110=ID,1,1\n" + +"111=ID,5,5,Interchange Control Version Number\n" + +"112=NO,9,9,Interchange Control Number\n" + +"113=ID,1,1,Acknowledgment Requested\n" + +"114=ID,1,1,Interchange Usage Indicator\n" + +"115=ID,1,1,Component Element Separator\n" + +"116=ID,3,15,Postal Code\n" + +"124=AN,2,15,Application Receiver Code\n" + +"127=AN,1,50,Reference Identification\n" + +"128=ID,2,3,Reference Identification Qualifier\n" + +"142=AN,2,15,Application Sender Code\n" + +"143=ID,3,3,Transaction Set Identifier Code\n" + +"156=ID,2,2,State or Province Code\n" + +"165=ID,1,1,Repetition Separator\n" + +"166=AN,1,55,Address Information\n" + +"234=AN,1,48,Product/Service ID\n" + +"235=ID,2,2,Product/Service ID Qualifier\n" + +"309=ID,1,2,Location Qualifier\n" + +"310=AN,1,30,Location Identifier\n" + +"329=AN,4,9,Transaction Set Control Number\n" + +"337=TM,4,8,Time\n" + +"352=AN,1,80,Description\n" + +"353=ID,2,2,Transaction Set Purpose Code\n" + +"364=AN,1,80,Communication Number\n" + +"365=ID,2,2,Communication Number Qualifier\n" + +"366=ID,2,2,Contact Function Code\n" + +"373=DT,8,8,Date\n" + +"374=ID,3,3,Date/Time Qualifier\n" + +"380=R,1,15,Quantity\n" + +"455=ID,1,2,Responsible Agency Code\n" + +"478=ID,1,1,Credit/Debit Flag Code\n" + +"479=ID,2,2,Functional Identifier Code\n" + +"480=AN,1,12,Version / Release / Industry Identifier Code\n" + +"481=ID,1,2,Trace Type Code\n" + +"509=AN,10,10,Originating Company Identifier\n" + +"522=ID,1,3,Amount Qualifier Code\n" + +"584=ID,2,2,Employment Status Code\n" + +"615=ID,1,2,Time Period Qualifier\n" + +"628=AN,1,12,Hierarchical ID Number\n" + +"640=ID,2,2,Transaction Type Code\n" + +"659=ID,1,2,Basis of Verification Code\n" + +"673=ID,2,2,Quantity Qualifier\n" + +"734=AN,1,12,Hierarchical Parent ID Number\n" + +"735=ID,1,12,Hierarchical Level Code\n" + +"736=ID,1,1,Hierarchical Child Code\n" + +"782=R,1,18,Monetary Amount\n" + +"799=AN,1,30,Version Identifier\n" + +"875=ID,3,3,Maintenance Type Code\n" + +"933=AN,1,264,Free-form Message Text\n" + +"934=ID,2,2,Printer Carriage Control Code\n" + +"954=R,1,10,Percent\n" + +"1005=ID,4,4,Hierarchical Structure Code\n" + +"1035=AN,1,60,Name Last or Organization Name\n" + +"1036=AN,1,25,Name First\n" + +"1037=AN,1,25,Name Middle\n" + +"1038=AN,1,10,Name Prefix\n" + +"1039=AN,1,10,Name Suffix\n" + +"1065=ID,1,1,Entity Type Qualifier\n" + +"1066=ID,1,2,Citizenship Status Code\n" + +"1067=ID,1,1,Marital Status Code\n" + +"1068=ID,1,1,Gender Code\n" + +"1069=ID,2,2,Individual Relationship Code\n" + +"1073=ID,1,1,Yes/No Condition or Response Code\n" + +"1109=ID,1,1\n" + +"1136=ID,2,2,Code Category\n" + +"1165=ID,1,1,Confidentiality Code\n" + +"1203=ID,2,3,Maintenance Reason Code\n" + +"1204=AN,1,50,Plan Coverage Description\n" + +"1207=ID,3,3,Coverage Level Code\n" + +"1216=ID,1,1,Benefit Status Code\n" + +"1218=ID,1,1\n" + +"1219=AN,1,2,COBRA\n" + +"1220=ID,1,1,Student Status Code\n" + +"1221=AN,1,3,Provider Code\n" + +"1250=ID,2,3,DateTime Period Format Qualifier\n" + +"1251=AN,1,35,Date Time Period\n" + +"1270=ID,2,3,Code List Qual Code\n" + +"1271=AN,1,30,Industry Code\n" + +"1328=NO,1,2,Diagnosis Code Pointer\n" + +"1336=ID,1,3,Insurance Type Code\n" + +"1339=AN,2,2,Procedure Modifier\n" + +"1365=ID,1,2,Service Type Code\n" + +"1470=NO,1,9,Number\n" + +"1705=AN,1,35,Implementation Convention Reference\n" + +"1715=ID,1,3,Country Subdivision Code\n" + +"11111112=NO,1,9,Interchange Control Number\n" + +"11111116=NO,1,5,Number of Included Functional Groups\n" + +"COMPOSITE ELEMENT DEFINITIONS\n" + +"C003=[235,O][234,O][1339,O][1339,O][1339,O][1339,O][352,O],@@....#\n" + +"C004=[1328,O][1328,O][1328,O][1328,O],@...\n" + +"C022=[1270,O][1271,O][1250,O][1251,O][782,O][380,O][799,O][1271,O][1073,O],@@#######\n" + +"SEGMENT DEFINITIONS\n" + +"AMT=[522][782][478],@@#\n" + +"BHT=[1005,M][353,M][127][373,M][337,M][640]\n" + +"DMG=[1250][1251][1068][1067][1109][1066][26][659][380]+P0102,...######\n" + +"DTP=[374,M][1250,M][1251,M]\n" + +"EQ=[1365][C003][1207][1336][C004]+R0102,..*1.#.*1,..*1##.*1\n" + +"GE=[97,M][28,M]\n" + +"GS=[479,M][142,M][124,M][373,M][337,M][28,M][455,M][480,M]\n" + +"HI=[C022][C022][C022][C022][C022][C022][C022][C022][C022][C022][C022][C022],@*1.*1.*1.*1.*1.*1.*1.*1#*1#*1#*1#*1\n" + +"HL=[628][734][735][736],@#@@,@@@@\n" + +"IEA=[11111116,M][11111112,M]\n" + +"III=[1270,M][1271,M]\n" + +"INS=[1073][1069][875][1203][1216][1218][1219][584][1220][1073][1250][1251][1165][19][156][26][1470],@@##############@,@@##############.\n" + +"ISA=[101,M][102,M][103,M][104,M][105,M][106,M][105,M][107,M][108,M][109,M][165,M][111,M][112,M][113,M][114,M][115,M]\n" + +"MSG=[933][934][1470],@##\n" + +"N3=[166,M][166]\n" + +"N4=[19][156][116][26][309][310][1715],@...##.,....##.,@...##.\n" + +"NM1=[98,M][1065,M][1035][1036][1037][1038][1039][66][67]+P0809,@@...#.@@,@@...#...,@@...#.##,@@@..#.@@\n" + +"PER=[366][93][365][364][365][364][365][364]+P0304P0506P0708,@.......\n" + +"PRV=[1221][128][127],@..\n" + +"REF=[128,M][127,M][352],@@#\n" + +"SE=[96,M][329,M]\n" + +"ST=[143,M][329,M][1705,M]\n" + +"TRN=[481,M][127,M][509,M][127]\n" + +"SEGMENT SELF RULES\n" + +"NM1~2~[EQ]1~4~0\n" + +"NM1~2~[EQ]2~2~4,5\n" + +"COMPOSITE ELEMENT SELF RULES\n" + +"CODELISTS\n" + +"FORMATS\n" + +"Date CCYYMMDD=^(((\\d{4}((0[13578]|1[02])(0[1-9]|[12]\\d|3[01])|(0[13456789]|1[012])(0[1-9]|[12]\\d|30)|02(0[1-9]|1\\d|2[0-8])))|((\\d{2}[02468][048]|\\d{2}[13579][26]))0229)){0,8}$\n" + +"EDI FILE STRUCTURE\n" + +"{INTERCHANGE HEADER:1[ISA,M]{FUNCTIONAL GROUP:1[GS,M]{ST HEADER:>1[ST,M][BHT,M]{2000A:>1[HL*1,M]{2100A:1[NM1*4,M]}{2000B:>1[HL*2,M]{2100B:1[NM1*4,M][REF,O,9][N3][N4*1][PRV*1]}{2000C:>1[HL*2,M][TRN,O,2]{2100C:1[NM1*2,M][REF*1,O,9][N3][N4*1][PRV*1][DMG*1][INS*1][HI*1][DTP,O,2]{2110C:99[EQ*1][AMT*1][AMT*1][III][REF*1][DTP]}{2000D:>1[HL*2,X][TRN,O,2]{2100D:1[NM1*3,M][REF*1,O,9][N3][N4*3][PRV*1][DMG*1][INS*2][HI*1][DTP,O,2]{2110D:99[EQ*2,M][III][REF*1][DTP]}}}}}}}{END ST HEADER LOOP:1[SE,M]}}{END GS LOOP:1[GE,M]}}{END ISA LOOP:1[IEA,M]}}\n" + +"ELEMENT CODES\n" + +"101=1:1,00,03\n" + +"103=1:3,00,01\n" + +"105=1:5,01,14,20,27,28,29,30,33,ZZ*1:7,01,14,20,27,28,29,30,33,ZZ\n" + +"111=1:12,00501\n" + +"113=1:14,0,1\n" + +"114=1:15,P,T\n" + +"479=2:1,HS\n" + +"455=2:7,X\n" + +"480=2:8,005010X279A1\n" + +"143=3:1,270\n" + +"1705=3:3,005010X279A1\n" + +"1005=4:1,0022\n" + +"353=4:2,01,13\n" + +"640=4:6,RT\n" + +"735=5:3,20*7:3,21*13:3,22*30:3,23\n" + +"736=5:4,1*7:4,1*13:4,0,1*30:4,0\n" + +"98=6:1,2B,36,GP,P5,PR*8:1,1P,2B,36,80,FA,GP,P5,PR*15:1,IL*32:1,03\n" + +"1065=6:2,1,2*8:2,1,2*15:2,1,2*32:2,1\n" + +"66=6:8,24,46,FI,NI,PI,XV,XX*8:8,24,34,FI,PI,PP,SV,XV,XX*15:8,II,MI\n" + +"128=9:1,0B,1C,1D,1J,4A,CT,EL,EO,HPI,JD,N5,N7,Q4,SY,TJ*12:2,PXC*16:1,18,1L,1W,3H,6P,CT,EA,EJ,F6,GH,HJ,IG,N6,NQ,SY,Y4*19:2,9K,D3,EI,HPI,PXC,SY,TJ*28:1,9F,G1*33:1,18,1L,1W,6P,CT,EA,EJ,F6,GH,HJ,IF,IG,MRC,N6,SY,Y4*36:2,9K,D3,EI,HPI,PXC,SY,TJ*43:1,9F,G1\n" + +"1221=12:1,AD,AT,BI,CO,CV,H,HH,LA,OT,P1,P2,PC,PE,R,RF,SB,SK,SU*19:1,AD,AT,BI,CO,CV,H,HH,LA,OT,P1,P2,PC,PE,R,RF,SK,SU*36:1,AD,AT,BI,CO,CV,H,HH,LA,OT,P1,P2,PC,PE,R,RF,SK,SU\n" + +"481=14:1,1*31:1,1\n" + +"1250=20:1,D8*23:2,D8,RD8*29:2,D8,RD8*37:1,D8*40:2,D8,RD8*44:2,D8,RD8\n" + +"1068=20:3,F,M*37:3,F,M\n" + +"1073=21:1,Y*38:1,N\n" + +"1069=21:2,18*38:2,01,19,34\n" + +"1270=22:1:1,ABK,BK*22:2:1,ABF,BF*22:3:1,ABF,BF*22:4:1,ABF,BF*22:5:1,ABF,BF*22:6:1,ABF,BF*22:7:1,ABF,BF*22:8:1,ABF,BF*27:1,ZZ*39:1:1,ABK,BK*39:2:1,ABF,BF*39:3:1,ABF,BF*39:4:1,ABF,BF*39:5:1,ABF,BF*39:6:1,ABF,BF*39:7:1,ABF,BF*39:8:1,ABF,BF*42:1,BF,BK,ZZ\n" + +"374=23:1,102,291*29:1,291*40:1,102,291*44:1,291\n" + +"1365=24:1,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,AA,AB,AC,AD,AE,AF,AG,AH,AI,AJ,AK,AL,AM,AN,AO,AQ,AR,B1,B2,B3,BA,BB,BC,BD,BE,BF,BG,BH,BI,BJ,BK,BL,BM,BN,BP,BQ,BR,BS,BT,BU,BV,BW,BX,BY,BZ,C1,CA,CB,CC,CD,CE,CF,CG,CH,CI,CJ,CK,CL,CM,CN,CO,CP,CQ,DG,DM,DS,GF,GN,GY,IC,MH,NI,ON,PT,PU,RN,RT,TC,TN,UC*41:1,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,30,32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,A0,A1,A2,A3,A4,A5,A6,A7,A8,A9,AA,AB,AC,AD,AE,AF,AG,AH,AI,AJ,AK,AL,AM,AN,AO,AQ,AR,BA,BB,BC,BD,BE,BF,BG,BH,BI,BJ,BK,BL,BM,BN,BP,BQ,BR,BS\n" + +"235=24:2:1,AD,CJ,HC,ID,IV,N4,ZZ*41:2:1,AD,CJ,HC,ID,IV,N4,ZZ\n" + +"1207=24:3,FAM*41:3,CHD,DEP,ECH,EMP,ESP,FAM,IND,SPC,SPO\n" + +"522=25:1,R*26:1,PB\n" + +"1336=41:4,AP,C1,CO,HM,IP,OT,PR,PS,SP,WC\n" + +"ELEMENT FORMATS\n" + +"1251=20:2,0,,Date CCYYMMDD\n" + +"SUMMARY\n" + +"ELEMENT EQUALITY\n" + +"1:13=47:2\n" + +"3:2=45:2\n" + +"RULES\n" + +"24=13:4'EQ'0!USAGE!2!1\n" + +"30=13:4'EQ'1!USAGE!2!1\n" + +"ELEMENT COUNTERS\n" + +"ELEMENT CODE DESCRIPTION\n" + +"LOOP DESCRIPTIONS\n" + +"INTERCHANGE HEADER=START OF INTERCHANGE HEADER\n" + +"FUNCTIONAL GROUP=START OF FUNCTIONAL GROUP\n" + +"ST HEADER=START OF ST HEADER\n" + +"2000A=INFORMATION SOURCE LEVEL\n" + +"2100A=INFORMATION SOURCE NAME\n" + +"2000B=INFORMATION RECEIVER LEVEL\n" + +"2100B=INFORMATION RECEIVER NAME\n" + +"2000C=SUBSCRIBER LEVEL\n" + +"2100C=SUBSCRIBER NAME\n" + +"2110C=SUBSCRIBER ELIGIBILITY OR BENEFIT INQUIRY\n" + +"2000D=DEPENDENT LEVEL\n" + +"2100D=DEPENDENT NAME\n" + +"2110D=DEPENDENT ELIGIBILITY OR BENEFIT INQUIRY\n" + +"END ST HEADER LOOP=END ST HEADER LOOP\n" + +"END GS LOOP=END OF FUNCTIONAL HEADER\n" + +"END ISA LOOP=END OF INTERCHANGE HEADER\n" + +"SEGMENT DESCRIPTIONS\n" + +"ISA=1,Interchange Header\n" + +"GS=2,Functional Group\n" + +"ST=3,Transaction Set Header\n" + +"BHT=4,Beginning of Hierarchical Transaction\n" + +"HL=5,Information Source Level\n" + +"NM1=6,Information Source Name\n" + +"HL=7,Information Receiver Level\n" + +"NM1=8,Information Receiver Name\n" + +"REF=9,Information Receiver Additional Identification\n" + +"N3=10,Information Receiver Address\n" + +"N4=11,Information Receiver City\n" + +"PRV=12,Information Receiver Provider Information\n" + +"HL=13,Subscriber Level\n" + +"TRN=14,Subscriber Trace Number\n" + +"NM1=15,Subscriber Name\n" + +"REF=16,Subscriber Additional Identification\n" + +"N3=17,Subscriber Address\n" + +"N4=18,Subscriber City\n" + +"PRV=19,Provider Information\n" + +"DMG=20,Subscriber Demographic Information\n" + +"INS=21,Multiple Birth Sequence Number\n" + +"HI=22,Subscriber Health Care Diagnosis Code\n" + +"DTP=23,Subscriber Date\n" + +"EQ=24,Subscriber Eligibility or Benefit Inquiry\n" + +"AMT=25,Subscriber Spend Down Amount\n" + +"AMT=26,Subscriber Spend Down Total Billed Amount\n" + +"III=27,Subscriber Eligibility or Benefit Additional Inquiry Information\n" + +"REF=28,Subscriber Additional Information\n" + +"DTP=29,Subscriber Eligibility/Benefit Date\n" + +"HL=30,Dependent Level\n" + +"TRN=31,Dependent Trace Number\n" + +"NM1=32,Dependent Name\n" + +"REF=33,Dependent Additional Identification\n" + +"N3=34,Dependent Address\n" + +"N4=35,Dependent City\n" + +"PRV=36,Provider Information\n" + +"DMG=37,Dependent Demographic Information\n" + +"INS=38,Dependent Relationship\n" + +"HI=39,Dependent Health Care Diagnosis Code\n" + +"DTP=40,Dependent Date\n" + +"EQ=41,Dependent Eligibility or Benefit Inquiry\n" + +"III=42,Dependent Eligibility or Benefit Additional Inquiry Information\n" + +"REF=43,Dependent Additional Information\n" + +"DTP=44,Dependent Eligibility/Benefit Date\n" + +"SAMPLE DATA"; \ No newline at end of file diff --git a/abnf/X12Service.grammar b/abnf/X12Service.grammar new file mode 100644 index 0000000..86caadf --- /dev/null +++ b/abnf/X12Service.grammar @@ -0,0 +1,509 @@ +'use strict'; + + +/** + * Generates functional/implementation and/or technical acknowledment(s) for the requested X12Interchange. + * + * body X12Interchange The X12Interchange object to acknowledge. (optional) + * basicSyntax Boolean All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The default syntax set is the Extended, hence the default for this parameter is false. By setting this to true, validation will use the Basic syntax set. (optional) + * syntaxSet String In case you need to validate against a syntax set, different than Basic and Extended, populate this filed with all of the allowed symbols, url-escaped. (optional) + * detectDuplicates Boolean If you need to detect duplicates as in functional groups or transactions with the same reference number, set this flag to true. The default is false. (optional) + * tranRefNumber Integer The default is 1. Set this to whatever the 997 or 999 X12Interchange.ST.TransactionSetControlNumber_02 needs to be. In case there are multiple acknowledgments (for multiple functional groups), this will be starting reference number and every subsequent acknowledgment will have the previous reference number incremented with 1. (optional) + * interchangeRefNumber Integer The default is 1. Set this to whatever the 997 or 999 X12Interchange.ISA.InterchangeControlNumber_13 needs to be. (optional) + * ackForValidTrans Boolean The default is false. Set this to true if you need AK2 loops included for all valid transaction as well. By default AK2 loops are generated only for invalid transactions. (optional) + * batchAcks Boolean The default is true. Set this to false if you need to generate separate X12Interchange for each acknowledgment. By default all acknowledgments are batched in the same X12Interchange. (optional) + * technicalAck String The default technical acknowledgment TA1 is generated according to X12Interchange.ISA.AcknowledgementRequested_14. You can either enforce it to always generate TA1s or supress it to never generate any TA1s. This will override the flag in X12Interchange.ISA.AcknowledgementRequested_14. The available values are: default, enforce, suppress. (optional) + * ack String The default value is 997. The type of acknowledgment being generated. Set this to 999 if you need to generate an implementation instead of functional acknowledgment. The available values are: 997, 999. (optional) + * ak901isP Boolean The value of the AK9's first element. By default it is \"E\". Set this to true if you want this value to be \"P\" instead. (optional) + * returns List + **/ +exports.x12AckPOST = function(body,basicSyntax,syntaxSet,detectDuplicates,tranRefNumber,interchangeRefNumber,ackForValidTrans,batchAcks,technicalAck,ack,ak901isP) { + return new Promise(function(resolve, reject) { + var examples = {}; + examples['application/json'] = [ { + "DataElementDelimiter" : "DataElementDelimiter", + "SegmentDelimiter" : "SegmentDelimiter", + "TA1" : { + "InterchangeDate_2" : "InterchangeDate_2", + "InterchangeAcknowledgmentCode_4" : "InterchangeAcknowledgmentCode_4", + "InterchangeTime_3" : "InterchangeTime_3", + "InterchangeControlNumber_1" : "InterchangeControlNumber_1", + "InterchangeNoteCode_5" : "InterchangeNoteCode_5" + }, + "ISA" : { + "InterchangeReceiverID_8" : "InterchangeReceiverID_8", + "SenderIDQualifier_5" : "SenderIDQualifier_5", + "AcknowledgementRequested_14" : "AcknowledgementRequested_14", + "SecurityInformation_4" : "SecurityInformation_4", + "InterchangeDate_9" : "InterchangeDate_9", + "InterchangeControlStandardsIdentifier_11" : "InterchangeControlStandardsIdentifier_11", + "ComponentElementSeparator_16" : "ComponentElementSeparator_16", + "SecurityInformationQualifier_3" : "SecurityInformationQualifier_3", + "AuthorizationInformationQualifier_1" : "AuthorizationInformationQualifier_1", + "InterchangeControlNumber_13" : "InterchangeControlNumber_13", + "InterchangeSenderID_6" : "InterchangeSenderID_6", + "UsageIndicator_15" : "UsageIndicator_15", + "ReceiverIDQualifier_7" : "ReceiverIDQualifier_7", + "InterchangeTime_10" : "InterchangeTime_10", + "AuthorizationInformation_2" : "AuthorizationInformation_2", + "InterchangeControlVersionNumber_12" : "InterchangeControlVersionNumber_12" + }, + "Groups" : [ { + "Transactions" : [ { }, { } ], + "GETrailers" : [ { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + }, { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + } ], + "GS" : { + "Time_5" : "Time_5", + "ReceiverIDCode_3" : "ReceiverIDCode_3", + "CodeIdentifyingInformationType_1" : "CodeIdentifyingInformationType_1", + "VersionAndRelease_8" : "VersionAndRelease_8", + "SenderIDCode_2" : "SenderIDCode_2", + "Date_4" : "Date_4", + "TransactionTypeCode_7" : "TransactionTypeCode_7", + "GroupControlNumber_6" : "GroupControlNumber_6" + } + }, { + "Transactions" : [ { }, { } ], + "GETrailers" : [ { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + }, { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + } ], + "GS" : { + "Time_5" : "Time_5", + "ReceiverIDCode_3" : "ReceiverIDCode_3", + "CodeIdentifyingInformationType_1" : "CodeIdentifyingInformationType_1", + "VersionAndRelease_8" : "VersionAndRelease_8", + "SenderIDCode_2" : "SenderIDCode_2", + "Date_4" : "Date_4", + "TransactionTypeCode_7" : "TransactionTypeCode_7", + "GroupControlNumber_6" : "GroupControlNumber_6" + } + } ], + "IEATrailers" : [ { + "InterchangeControlNumber_2" : "InterchangeControlNumber_2", + "NumberOfIncludedGroups_1" : "NumberOfIncludedGroups_1" + }, { + "InterchangeControlNumber_2" : "InterchangeControlNumber_2", + "NumberOfIncludedGroups_1" : "NumberOfIncludedGroups_1" + } ], + "Result" : { + "Status" : "Status", + "Details" : [ { + "Status" : "Status", + "Message" : "Message", + "SegmentId" : "SegmentId", + "TransactionIndex" : 1, + "TransactionRef" : "TransactionRef", + "Value" : "Value", + "Index" : 6, + "DataElementIndex" : 5 + }, { + "Status" : "Status", + "Message" : "Message", + "SegmentId" : "SegmentId", + "TransactionIndex" : 1, + "TransactionRef" : "TransactionRef", + "Value" : "Value", + "Index" : 6, + "DataElementIndex" : 5 + } ], + "LastIndex" : 0 + } +}, { + "DataElementDelimiter" : "DataElementDelimiter", + "SegmentDelimiter" : "SegmentDelimiter", + "TA1" : { + "InterchangeDate_2" : "InterchangeDate_2", + "InterchangeAcknowledgmentCode_4" : "InterchangeAcknowledgmentCode_4", + "InterchangeTime_3" : "InterchangeTime_3", + "InterchangeControlNumber_1" : "InterchangeControlNumber_1", + "InterchangeNoteCode_5" : "InterchangeNoteCode_5" + }, + "ISA" : { + "InterchangeReceiverID_8" : "InterchangeReceiverID_8", + "SenderIDQualifier_5" : "SenderIDQualifier_5", + "AcknowledgementRequested_14" : "AcknowledgementRequested_14", + "SecurityInformation_4" : "SecurityInformation_4", + "InterchangeDate_9" : "InterchangeDate_9", + "InterchangeControlStandardsIdentifier_11" : "InterchangeControlStandardsIdentifier_11", + "ComponentElementSeparator_16" : "ComponentElementSeparator_16", + "SecurityInformationQualifier_3" : "SecurityInformationQualifier_3", + "AuthorizationInformationQualifier_1" : "AuthorizationInformationQualifier_1", + "InterchangeControlNumber_13" : "InterchangeControlNumber_13", + "InterchangeSenderID_6" : "InterchangeSenderID_6", + "UsageIndicator_15" : "UsageIndicator_15", + "ReceiverIDQualifier_7" : "ReceiverIDQualifier_7", + "InterchangeTime_10" : "InterchangeTime_10", + "AuthorizationInformation_2" : "AuthorizationInformation_2", + "InterchangeControlVersionNumber_12" : "InterchangeControlVersionNumber_12" + }, + "Groups" : [ { + "Transactions" : [ { }, { } ], + "GETrailers" : [ { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + }, { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + } ], + "GS" : { + "Time_5" : "Time_5", + "ReceiverIDCode_3" : "ReceiverIDCode_3", + "CodeIdentifyingInformationType_1" : "CodeIdentifyingInformationType_1", + "VersionAndRelease_8" : "VersionAndRelease_8", + "SenderIDCode_2" : "SenderIDCode_2", + "Date_4" : "Date_4", + "TransactionTypeCode_7" : "TransactionTypeCode_7", + "GroupControlNumber_6" : "GroupControlNumber_6" + } + }, { + "Transactions" : [ { }, { } ], + "GETrailers" : [ { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + }, { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + } ], + "GS" : { + "Time_5" : "Time_5", + "ReceiverIDCode_3" : "ReceiverIDCode_3", + "CodeIdentifyingInformationType_1" : "CodeIdentifyingInformationType_1", + "VersionAndRelease_8" : "VersionAndRelease_8", + "SenderIDCode_2" : "SenderIDCode_2", + "Date_4" : "Date_4", + "TransactionTypeCode_7" : "TransactionTypeCode_7", + "GroupControlNumber_6" : "GroupControlNumber_6" + } + } ], + "IEATrailers" : [ { + "InterchangeControlNumber_2" : "InterchangeControlNumber_2", + "NumberOfIncludedGroups_1" : "NumberOfIncludedGroups_1" + }, { + "InterchangeControlNumber_2" : "InterchangeControlNumber_2", + "NumberOfIncludedGroups_1" : "NumberOfIncludedGroups_1" + } ], + "Result" : { + "Status" : "Status", + "Details" : [ { + "Status" : "Status", + "Message" : "Message", + "SegmentId" : "SegmentId", + "TransactionIndex" : 1, + "TransactionRef" : "TransactionRef", + "Value" : "Value", + "Index" : 6, + "DataElementIndex" : 5 + }, { + "Status" : "Status", + "Message" : "Message", + "SegmentId" : "SegmentId", + "TransactionIndex" : 1, + "TransactionRef" : "TransactionRef", + "Value" : "Value", + "Index" : 6, + "DataElementIndex" : 5 + } ], + "LastIndex" : 0 + } +} ]; + if (Object.keys(examples).length > 0) { + resolve(examples[Object.keys(examples)[0]]); + } else { + resolve(); + } + }); +} + + +/** + * Reads an X12 file and returns its contents translated to an array of X12Interchange objects. + * + * fileName byte[] (optional) + * ignoreNullValues Boolean Whether to ignore all null values in the response. The default is false. (optional) + * continueOnError Boolean Whether to continue reading if a corrupt interchange is encountered. The default is false. (optional) + * charSet String The encoding of the file contents. The default is utf-8. The available values are: unicodeFFFE, utf-32, utf-32BE, us-ascii, iso-8859-1, utf-7, utf-8, utf-16. (optional) + * model String The model to use. By default, the API will infer the model based on the transaction and version identifiers. (optional) + * returns List + **/ +exports.x12ReadPOST = function(fileName,ignoreNullValues,continueOnError,charSet,model) { + return new Promise(function(resolve, reject) { + var examples = {}; + examples['application/json'] = [ { + "DataElementDelimiter" : "DataElementDelimiter", + "SegmentDelimiter" : "SegmentDelimiter", + "TA1" : { + "InterchangeDate_2" : "InterchangeDate_2", + "InterchangeAcknowledgmentCode_4" : "InterchangeAcknowledgmentCode_4", + "InterchangeTime_3" : "InterchangeTime_3", + "InterchangeControlNumber_1" : "InterchangeControlNumber_1", + "InterchangeNoteCode_5" : "InterchangeNoteCode_5" + }, + "ISA" : { + "InterchangeReceiverID_8" : "InterchangeReceiverID_8", + "SenderIDQualifier_5" : "SenderIDQualifier_5", + "AcknowledgementRequested_14" : "AcknowledgementRequested_14", + "SecurityInformation_4" : "SecurityInformation_4", + "InterchangeDate_9" : "InterchangeDate_9", + "InterchangeControlStandardsIdentifier_11" : "InterchangeControlStandardsIdentifier_11", + "ComponentElementSeparator_16" : "ComponentElementSeparator_16", + "SecurityInformationQualifier_3" : "SecurityInformationQualifier_3", + "AuthorizationInformationQualifier_1" : "AuthorizationInformationQualifier_1", + "InterchangeControlNumber_13" : "InterchangeControlNumber_13", + "InterchangeSenderID_6" : "InterchangeSenderID_6", + "UsageIndicator_15" : "UsageIndicator_15", + "ReceiverIDQualifier_7" : "ReceiverIDQualifier_7", + "InterchangeTime_10" : "InterchangeTime_10", + "AuthorizationInformation_2" : "AuthorizationInformation_2", + "InterchangeControlVersionNumber_12" : "InterchangeControlVersionNumber_12" + }, + "Groups" : [ { + "Transactions" : [ { }, { } ], + "GETrailers" : [ { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + }, { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + } ], + "GS" : { + "Time_5" : "Time_5", + "ReceiverIDCode_3" : "ReceiverIDCode_3", + "CodeIdentifyingInformationType_1" : "CodeIdentifyingInformationType_1", + "VersionAndRelease_8" : "VersionAndRelease_8", + "SenderIDCode_2" : "SenderIDCode_2", + "Date_4" : "Date_4", + "TransactionTypeCode_7" : "TransactionTypeCode_7", + "GroupControlNumber_6" : "GroupControlNumber_6" + } + }, { + "Transactions" : [ { }, { } ], + "GETrailers" : [ { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + }, { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + } ], + "GS" : { + "Time_5" : "Time_5", + "ReceiverIDCode_3" : "ReceiverIDCode_3", + "CodeIdentifyingInformationType_1" : "CodeIdentifyingInformationType_1", + "VersionAndRelease_8" : "VersionAndRelease_8", + "SenderIDCode_2" : "SenderIDCode_2", + "Date_4" : "Date_4", + "TransactionTypeCode_7" : "TransactionTypeCode_7", + "GroupControlNumber_6" : "GroupControlNumber_6" + } + } ], + "IEATrailers" : [ { + "InterchangeControlNumber_2" : "InterchangeControlNumber_2", + "NumberOfIncludedGroups_1" : "NumberOfIncludedGroups_1" + }, { + "InterchangeControlNumber_2" : "InterchangeControlNumber_2", + "NumberOfIncludedGroups_1" : "NumberOfIncludedGroups_1" + } ], + "Result" : { + "Status" : "Status", + "Details" : [ { + "Status" : "Status", + "Message" : "Message", + "SegmentId" : "SegmentId", + "TransactionIndex" : 1, + "TransactionRef" : "TransactionRef", + "Value" : "Value", + "Index" : 6, + "DataElementIndex" : 5 + }, { + "Status" : "Status", + "Message" : "Message", + "SegmentId" : "SegmentId", + "TransactionIndex" : 1, + "TransactionRef" : "TransactionRef", + "Value" : "Value", + "Index" : 6, + "DataElementIndex" : 5 + } ], + "LastIndex" : 0 + } +}, { + "DataElementDelimiter" : "DataElementDelimiter", + "SegmentDelimiter" : "SegmentDelimiter", + "TA1" : { + "InterchangeDate_2" : "InterchangeDate_2", + "InterchangeAcknowledgmentCode_4" : "InterchangeAcknowledgmentCode_4", + "InterchangeTime_3" : "InterchangeTime_3", + "InterchangeControlNumber_1" : "InterchangeControlNumber_1", + "InterchangeNoteCode_5" : "InterchangeNoteCode_5" + }, + "ISA" : { + "InterchangeReceiverID_8" : "InterchangeReceiverID_8", + "SenderIDQualifier_5" : "SenderIDQualifier_5", + "AcknowledgementRequested_14" : "AcknowledgementRequested_14", + "SecurityInformation_4" : "SecurityInformation_4", + "InterchangeDate_9" : "InterchangeDate_9", + "InterchangeControlStandardsIdentifier_11" : "InterchangeControlStandardsIdentifier_11", + "ComponentElementSeparator_16" : "ComponentElementSeparator_16", + "SecurityInformationQualifier_3" : "SecurityInformationQualifier_3", + "AuthorizationInformationQualifier_1" : "AuthorizationInformationQualifier_1", + "InterchangeControlNumber_13" : "InterchangeControlNumber_13", + "InterchangeSenderID_6" : "InterchangeSenderID_6", + "UsageIndicator_15" : "UsageIndicator_15", + "ReceiverIDQualifier_7" : "ReceiverIDQualifier_7", + "InterchangeTime_10" : "InterchangeTime_10", + "AuthorizationInformation_2" : "AuthorizationInformation_2", + "InterchangeControlVersionNumber_12" : "InterchangeControlVersionNumber_12" + }, + "Groups" : [ { + "Transactions" : [ { }, { } ], + "GETrailers" : [ { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + }, { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + } ], + "GS" : { + "Time_5" : "Time_5", + "ReceiverIDCode_3" : "ReceiverIDCode_3", + "CodeIdentifyingInformationType_1" : "CodeIdentifyingInformationType_1", + "VersionAndRelease_8" : "VersionAndRelease_8", + "SenderIDCode_2" : "SenderIDCode_2", + "Date_4" : "Date_4", + "TransactionTypeCode_7" : "TransactionTypeCode_7", + "GroupControlNumber_6" : "GroupControlNumber_6" + } + }, { + "Transactions" : [ { }, { } ], + "GETrailers" : [ { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + }, { + "NumberOfIncludedSets_1" : "NumberOfIncludedSets_1", + "GroupControlNumber_2" : "GroupControlNumber_2" + } ], + "GS" : { + "Time_5" : "Time_5", + "ReceiverIDCode_3" : "ReceiverIDCode_3", + "CodeIdentifyingInformationType_1" : "CodeIdentifyingInformationType_1", + "VersionAndRelease_8" : "VersionAndRelease_8", + "SenderIDCode_2" : "SenderIDCode_2", + "Date_4" : "Date_4", + "TransactionTypeCode_7" : "TransactionTypeCode_7", + "GroupControlNumber_6" : "GroupControlNumber_6" + } + } ], + "IEATrailers" : [ { + "InterchangeControlNumber_2" : "InterchangeControlNumber_2", + "NumberOfIncludedGroups_1" : "NumberOfIncludedGroups_1" + }, { + "InterchangeControlNumber_2" : "InterchangeControlNumber_2", + "NumberOfIncludedGroups_1" : "NumberOfIncludedGroups_1" + } ], + "Result" : { + "Status" : "Status", + "Details" : [ { + "Status" : "Status", + "Message" : "Message", + "SegmentId" : "SegmentId", + "TransactionIndex" : 1, + "TransactionRef" : "TransactionRef", + "Value" : "Value", + "Index" : 6, + "DataElementIndex" : 5 + }, { + "Status" : "Status", + "Message" : "Message", + "SegmentId" : "SegmentId", + "TransactionIndex" : 1, + "TransactionRef" : "TransactionRef", + "Value" : "Value", + "Index" : 6, + "DataElementIndex" : 5 + } ], + "LastIndex" : 0 + } +} ]; + if (Object.keys(examples).length > 0) { + resolve(examples[Object.keys(examples)[0]]); + } else { + resolve(); + } + }); +} + + +/** + * Validates an X12Interchange object according to the X12 standard rules for each version and transaction. + * + * body X12Interchange The X12Interchange object to validate. (optional) + * basicSyntax Boolean All data elements with alpha (A) or alphanumeric (AN) data types are validated against a syntax set of allowed characters. The default syntax set is the Extended, hence the default for this parameter is false. By setting this to true, validation will use the Basic syntax set. (optional) + * syntaxSet String In case you need to validate against a syntax set, different than Basic and Extended, populate this filed with all of the allowed symbols, url-escaped. (optional) + * skipTrailer Boolean You are allowed to validate an X12Interchange with missing interchange, functional group or transaction trailers (IEA, GE, SE). This is because these will be automatically applied during the Write oprtaion so you don't have to worry about counting the items. By default it is expected that all trailers are present when you validate the X12Interchange and by default, this is set to false. To skip all trailer validation, set this to true. (optional) + * structureOnly Boolean This is equivalent to HIPAA Snip level 1, where only the structure and control segments are validated. By default, this is set to false, however if you want to not validate things such as data types, number of repeteitions or dates, set this to true. (optional) + * returns OperationResult + **/ +exports.x12ValidatePOST = function(body,basicSyntax,syntaxSet,skipTrailer,structureOnly) { + return new Promise(function(resolve, reject) { + var examples = {}; + examples['application/json'] = { + "Status" : "Status", + "Details" : [ { + "Status" : "Status", + "Message" : "Message", + "SegmentId" : "SegmentId", + "TransactionIndex" : 1, + "TransactionRef" : "TransactionRef", + "Value" : "Value", + "Index" : 6, + "DataElementIndex" : 5 + }, { + "Status" : "Status", + "Message" : "Message", + "SegmentId" : "SegmentId", + "TransactionIndex" : 1, + "TransactionRef" : "TransactionRef", + "Value" : "Value", + "Index" : 6, + "DataElementIndex" : 5 + } ], + "LastIndex" : 0 +}; + if (Object.keys(examples).length > 0) { + resolve(examples[Object.keys(examples)[0]]); + } else { + resolve(); + } + }); +} + + +/** + * Translates an X12Interchange object to a raw X12 interchange and returns it as a stream. + * + * body X12Interchange The X12Interchange object to translate to raw X12. (optional) + * preserveWhitespace Boolean Whether to preserve blank data elements so the output contains multiple delimiters instead of omitting any excess delimiters. The default is false. (optional) + * charSet String The encoding of the file contents. The default is utf-8. The available values are: unicodeFFFE, utf-32, utf-32BE, us-ascii, iso-8859-1, utf-7, utf-8, utf-16. (optional) + * postfix String The postfix to be applied at the end of each segment, just after the segment separator. This is usually a carriage return (CR), line feed (LF) or both. By default, there is no postfix. (optional) + * returns byte[] + **/ +exports.x12WritePOST = function(body,preserveWhitespace,charSet,postfix) { + return new Promise(function(resolve, reject) { + var examples = {}; + examples['application/json'] = ""; + if (Object.keys(examples).length > 0) { + resolve(examples[Object.keys(examples)[0]]); + } else { + resolve(); + } + }); +} + diff --git a/abnf/abnf. b/abnf/abnf. new file mode 100644 index 0000000..5cc686a --- /dev/null +++ b/abnf/abnf. @@ -0,0 +1,14 @@ + #ABNF V1.0 ISO-8859-1; + language en-US; + {TAG-CONTENT-1}; + {!{TAG-CONTENT-2}!}; + + $rule = . . .; + ... + + + $rule1 = this is a {TAG-CONTENT-1} test {TAG-CONTENT-2}; + +$rule2 = open {TAG-CONTENT-1} | $close {TAG-CONTENT-2}; + +$rule3 = {!{ a simple tag containing { and } needs no escaping }!}; \ No newline at end of file diff --git a/abnf/drafts.bill-of-lading.txt b/abnf/drafts.bill-of-lading.txt new file mode 100644 index 0000000..8ebf15c --- /dev/null +++ b/abnf/drafts.bill-of-lading.txt @@ -0,0 +1,185 @@ +# Bill of Lading Digital Instrument + +## License + +CC-ND-NC-2.5 +FreightTrust and Clearing Corporation + +## Overview + +## Codes + +### 33 Lading Exception Code +TYPE=ID MIN=1 MAX=1 + +Code indicating the condition of the shipment + + + +A All Short +D Damaged +E Entire Shipment Refused +O Overage +P Partial Shipment +W Wrong Product + + +### 79 Lading Description +TYPE=AN MIN=1 MAX=50 + +Description of an item as required for rating and billing purposes + +### 80 Lading Quantity +TYPE=N0 MIN=1 MAX=7 + +Number of units (pieces) of the lading commodity + +### 148 Lading Value +TYPE=R MIN=2 MAX=9 + +Value of shipment for export, expressed in the standard monetary denomination for the currency specified + + +### 213 Lading Line Item Number +TYPE=N0 MIN=1 MAX=3 + +Sequential line number for a lading item + +### 372 Lading Liability Code +TYPE=ID MIN=1 MAX=1 + +Code identifying limits of liability + + + +F Full Liability +L Limited Liability + +### 392 Bill of Lading Status Code +TYPE=ID MIN=1 MAX=2 + +Code indicating the status of a bill of lading + + + +1 Carrier/port authority desires an extension of the lay order period +2 Released by Customs +3 Send to General Order + + +### 414 Lading Quantity Received +TYPE=N0 MIN=1 MAX=7 + +Number of units (pieces) of the lading quantity received + +### 582 Bill of Lading Type Code +TYPE=ID MIN=2 MAX=2 + +Code identifying the type of bill of lading + + + +00 Neither Space Charter nor Master In-bond +01 Space Charter +10 Master In-Bond +11 Both Space Charter and Master In-Bond +12 Empty Equipment +13 Section 321 Tariff Act (TA) 1930 (Shipments Valued at $200.00 or Less) +14 Intangible goods +15 Returned goods +16 Gifts +17 Monthly Manifest +18 Returned American Goods +19 New Equipment First Transborder Movement +20 Track 4 Release Eligible + + +### 592 Lading Description Qualifier +TYPE=ID MIN=1 MAX=1 + +Code identifying the type of lading description + + + +B Bill of Lading Description (Destination Country's Language) +C Chemical Description +D Department of Transportation Description +E Export License Description +I Commercial Invoice Description +L Letter of Credit Description +P Product Description + + +### 598 Bill of Lading/Waybill Number +TYPE=AN MIN=1 MAX=12 + +Identification number assigned to the shipment by the carrier or consolidator + +### 644 Lading Percent Qualifier +TYPE=ID MIN=1 MAX=1 + +Code identifying type of lading percentage + + + +A Coal Moisture Allowance +M Tank Car Mixture +O Tank Car Outage +S Sand or Stone and Related Articles (Aggregates) + +### 643 Lading Percentage +TYPE=N2 MIN=2 MAX=4 + +Commodity percentage for rating + +1602 Bill of Lading Charge Code +TYPE=ID MIN=3 MAX=3 + +Code identifying the type of Bill of Lading charge + + + +ADF Advance Fee +ADV Advance Amount +BLK Blocking and Bracing Charge +COD Cash on Delivery +COL Fee for Collecting COD +DEL Delivery Charge +DEP Detention of Power Unit +DET Detention of Trailer +DIB Diversion and Reconsignment +DSC Discount +EIC Export and/or Import Charge +EXC Exclusive Use Charge +FLT Flat Charge +FSC Fuel Surcharge +IDL Inside Delivery +IPU Inside Pick-up +LDA Loading Allowance +LDL Unloading Allowance +MIL Mileage Charge +MIN Minimum Charge +MRK Marking or Tagging Charge +MSG Miscellaneous Charge +ONC Order Notify Charge +PLA Placement Charge +PWH Pier Charges - Wharfage +REP Residential Pick-up +RES Residential Delivery +SOC Stop Charge +SPU Single Pick-up +SRG Storage +SUF Sufferance Warehouse +ZZZ Mutually Defined + + +### 59 Freight Class Code +TYPE=AN MIN=2 MAX=5 + +Code indicating generalized classification that applies to one or more items in the shipment, i.e., class 70, 77.5, etc. + +### 60 Freight Rate +TYPE=R MIN=1 MAX=9 + +Rate that applies to the specific commodity + diff --git a/abnf/drafts.txt b/abnf/drafts.txt new file mode 100644 index 0000000..5237920 --- /dev/null +++ b/abnf/drafts.txt @@ -0,0 +1,43 @@ +$ruleName = ruleExpansion; +public $ruleName = ruleExpansion; +private $ruleName = ruleExpansion; + + version := "MIME-Version" ":" 1*DIGIT "." 1*DIGIT + MIME-part-headers := entity-headers + [ fields ] + ; Any field not beginning with + ; "content-" can have no defined + ; meaning and may be ignored. + ; The ordering of the header + ; fields implied by this BNF + ; definition should be ignored + entity-headers := [ content CRLF ] + [ encoding CRLF ] + [ id CRLF ] + [ description CRLF ] + *( MIME-extension-field CRLF ) + + MIME-message-headers := entity-headers + fields + version CRLF + ; The ordering of the header + ; fields implied by this BNF + ; definition should be ignored. + + dkim-quoted-printable = *(FWS / hex-octet / dkim-safe-char) + ; hex-octet is from RFC2045 + dkim-safe-char = %x21-3A / %x3C / %x3E-7E + ; '!' - ':', '<', '>' - '~' + + tag-list = tag-spec *( ";" tag-spec ) [ ";" ] + tag-spec = [FWS] tag-name [FWS] "=" [FWS] tag-value [FWS] + tag-name = ALPHA *ALNUMPUNC + tag-value = [ tval *( 1*(WSP / FWS) tval ) ] + ; Prohibits WSP and FWS at beginning and end + tval = 1*VALCHAR + VALCHAR = %x21-3A / %x3C-7E + ; EXCLAMATION to TILDE except SEMICOLON + ALNUMPUNC = ALPHA / DIGIT / "_" + WSP = SP / HTAB + LWSP = *(WSP / CRLF WSP) + FWS = [*WSP CRLF] 1*WSP \ No newline at end of file diff --git a/abnf/dtmf.abnf b/abnf/dtmf.abnf new file mode 100644 index 0000000..76abdc7 --- /dev/null +++ b/abnf/dtmf.abnf @@ -0,0 +1,4 @@ +mode dtmf; + +$digit = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9; +public $pin = $digit <4> "#" | "*" 9; \ No newline at end of file diff --git a/abnf/rules.abnf b/abnf/rules.abnf new file mode 100644 index 0000000..d553e1b --- /dev/null +++ b/abnf/rules.abnf @@ -0,0 +1,32 @@ +// copyright 2020 - FreighTTrust and Clearing Corporation +// License under Mozilla Public License 2.0 +// ABNF for Platform General (Not specific) +#ABNF 1.0 ISO-8859-1; + +root $rules; + +rules $command = $action $object; + +public $public = public $public | public; +// Default grammar language is US English +language en-US; + +$define = CHARS +$ALNUMPUNC = ALPHA / DIGIT / "_"; +$VALCHAR = %x21-3A / %x3C-7E + EXCLAMATION to TILDE except SEMICOLON; + +$WSP = SP / HTAB; +$LWSP = *(WSP / CRLF WSP); +$FWS = [*WSP CRLF] 1*WSP; + +$tag-list = tag specifications; +$command = tag-spec *( ";" tag-spec ) [ ";" ]; + +tag-spec = [FWS] tag-name [FWS] "=" [FWS] tag-value [FWS] +$command +$tag-name = name; +$command = ALPHA *ALNUMPUNC; + +$tag-value = value | NUM | ALPHA; +$command = [ tval *( 1*(WSP / FWS) tval ) ]; \ No newline at end of file diff --git a/components/EventComponents.yaml b/components/EventComponents.yaml new file mode 100644 index 0000000..cc71025 --- /dev/null +++ b/components/EventComponents.yaml @@ -0,0 +1,22 @@ +components: + schemas: + event: + description: The event entity is described as a generalization of all the specific event categories. An event always takes place in relation to a shipment and can additionally be linked to a transport or an equipment + type: object + properties: + eventID: + $ref: '#/components/schemas/eventID' + eventType: + $ref: '#/components/schemas/eventType' + eventDateTime: + $ref: '#/components/schemas/eventDateTime' + eventClassifierCode: + $ref: '#/components/schemas/eventClassifierCode' + eventTypeCode: + $ref: '#/components/schemas/eventTypeCode' + required: + - eventID + - eventType + - eventDateTime + - eventClassifierCode + - eventTypeCode \ No newline at end of file diff --git a/components/EventShippments.yaml b/components/EventShippments.yaml new file mode 100644 index 0000000..4065c7e --- /dev/null +++ b/components/EventShippments.yaml @@ -0,0 +1,84 @@ +events: + type: object + description: List of events for shipment journey. + properties: + events: + type: array + items: + anyOf: + - $ref: '#/components/schemas/transportEvent' + - $ref: '#/components/schemas/shipmentEvent' + - $ref: '#/components/schemas/equipmentEvent' + - $ref: '#/components/schemas/transportEquipmentEvent' + discriminator: + propertyName: eventType + required: + - events + error: + type: object + required: + - httpMethod + - requestUri + - errors + - statusCode + - statusCodeText + - errorDateTime + properties: + httpMethod: + description: The HTTP request method type + type: string + example: POST + requestUri: + description: The request URI. + type: string + example: https://dcsa.org/dcsa/tnt/v1/events + errors: + $ref: '#/components/schemas/errors' + statusCode: + description: The HTTP status code + type: string + example: 400 + statusCodeText: + description: The textual representation of the response status. + type: string + example: Bad Request + errorDateTime: + description: The date and time (in ISO 8601 format) the error occured. + type: string + example: '2020-06-13T37:41:00+08:30' + errors: + type: array + items: + type: object + properties: + reason: + description: High level error message. + type: string + example: invalidQuery + message: + description: Detailed error message. + type: string + example: The request did not contain one of the three required query parameters. + required: + - reason + - message + eventSubscriptionBody: + description: The object used by the POST event-subscriptions endpoint + type: object + properties: + callbackUrl: + $ref: '#/components/schemas/callbackUrl' + eventType: + $ref: '#/components/schemas/eventTypeList' + bookingReference: + $ref: '#/components/schemas/bookingReference' + billOfLadingNumber: + $ref: '#/components/schemas/billOfLadingNumber' + equipmentReference: + $ref: '#/components/schemas/equipmentReference' + required: + - callbackUrl + eventSubscription: + allOf: + - $ref: '#/components/schemas/subscriptionID' + - $ref: '#/components/schemas/eventSubscriptionBody' \ No newline at end of file diff --git a/components/ReferenceVariables.yaml b/components/ReferenceVariables.yaml new file mode 100644 index 0000000..0c899f2 --- /dev/null +++ b/components/ReferenceVariables.yaml @@ -0,0 +1,121 @@ +variableReference: +info: + version: "2.1.0" + title: 'Protocol specifications' + description: 'protocol values' + license: + name: Mozilla Public License 2.0 + url: hhttps://www.mozilla.org/en-US/MPL/2.0/ + contact: + name: Freight Trust and Clearing Corporation + url: https://freighttrust.com + email: protocol@freighttrust.com +paths: + /{reference}/{subscriptionID}: + summary: + parameters: + - in: path + name: {reference} + schema: + type: string + required: true + description: + bookingReference: + type: string + example: ABC709951 + description: The identifier for a shipment, which is issued by and unique within each of the carriers. + transportReference: + type: string + example: 9648714 + description: The reference for the transport, e.g. when the mode of transport is a vessel, the transport reference will be the vessel IMO number. + equipmentReference: + type: string + example: APZU4812090 + description: The unique identifier for the equipment, which should follow the BIC ISO Container Identification Number where possible. If a container is not yet assigned to a shipment, the interface cannot return any information when an equipment reference is given as input. If a container is assigned to an (active) shipment, the interface returns information on the active shipment. + billOfLadingNumber: + type: string + example: ABCD421911263977 + description: Bill of lading number is an identifier that links to a shipment. Bill of Lading is the legal document issued to the customer, which confirms the carrier's receipt of the cargo from the customer acknowledging goods being shipped and specifying the terms of delivery. + facilityTypeCode: + type: string + example: POTE + description: The code to identify the specific type of facility. + UNLocationCode: + type: string + example: USNYC + description: The UN Location Code identifies a location in the sense of a city/a town/a village, being the smaller administrative area existing as defined by the competent national authority in each country. + facilityCode: + type: string + example: AEAUHADT + description: The code used for identifying the specific facility. + otherFacility: + type: string + example: Depot location or address + description: An alternative way to capture the facility when no standardized DCSA facility code can be found. + emptyIndicatorCode: + type: string + example: Empty + description: Code to denote whether the equipment is empty or laden. + shipmentInformationTypeCode: + type: string + example: SRM + description: The code to identify the type of information that is related to the shipment. + transportLegReference: + type: string + example: 025E + description: | + The transport leg reference will be specific per mode of transport: + - Vessel: Voyage number as specified by the vessel operator + - Truck: Not yet specified + - Rail: Not yet specified + - Barge: Not yet specified. + eventDateTime: + type: string + format: date-time + example: '2019-11-12T07:41:00+08:30' + description: The local date and time, where the event took place, in ISO 8601 format. + eventID: + type: string + example: 1 + description: The unique identifier for the Equipment Event ID/Transport Event ID/Shipment Event ID. + eventClassifierCode: + type: string + example: ACT + description: Code for the event classifier, either PLN, ACT or EST. + eventTypeCode: + type: string + example: ARRI + description: Unique identifier for Event Type Code. + modeOfTransportCode: + type: string + example: 1 + description: A code specifying a type of transport mode. + subscriptionID: + type: object + properties: + subscriptionID: + type: string + example: jlke123j + description: The carrier issues a unique ID to the shipper or consignee for that subscription + callbackUrl: # Callback URL + type: string + format: uri + nullable: false + example: https://myserver.com/send/callback/here + description: Your server, where the API server should send the event data + eventType: + description: The Event Type of the object. + nullable: false + type: string + enum: + - EQUIPMENT + - SHIPMENT + - TRANSPORT + - TRANSPORTEQUIPMENT + eventTypeList: + description: A list of event types. Default is all events + example: [EQUIPMENT,SHIPMENT,TRANSPORT,TRANSPORTEQUIPMENT] + default: [EQUIPMENT,SHIPMENT,TRANSPORT,TRANSPORTEQUIPMENT] + type: array + items: + $ref: '#/components/schemas/eventType' \ No newline at end of file diff --git a/components/equipmentEvent.yaml b/components/equipmentEvent.yaml new file mode 100644 index 0000000..2276c6b --- /dev/null +++ b/components/equipmentEvent.yaml @@ -0,0 +1,29 @@ +equipmentEvent: + description: The equipment event entity is a specialization of the event entity to support specification of data that only applies to an equipment event. + allOf: + - $ref: '#/components/schemas/event' + - type: object + properties: + eventType: #Overriding this property to have correct payload response examples + type: string + example: EQUIPMENT + nullable: false + enum: + - EQUIPMENT + equipmentReference: + $ref: '#/components/schemas/equipmentReference' + facilityTypeCode: + $ref: '#/components/schemas/facilityTypeCode' + UNLocationCode: + $ref: '#/components/schemas/UNLocationCode' + facilityCode: + $ref: '#/components/schemas/facilityCode' + otherFacility: + $ref: '#/components/schemas/otherFacility' + emptyIndicatorCode: + $ref: '#/components/schemas/emptyIndicatorCode' + required: + - facilityTypeCode + - UNLocationCode + - facilityCode + - emptyIndicatorCode \ No newline at end of file diff --git a/components/shipmentEvent.yaml b/components/shipmentEvent.yaml new file mode 100644 index 0000000..9934efc --- /dev/null +++ b/components/shipmentEvent.yaml @@ -0,0 +1,16 @@ +shipmentEvent: + description: The shipment event entity is a specialization of the event entity to support specification of data that only applies to a shipment event. + allOf: + - $ref: '#/components/schemas/event' + - type: object + properties: + eventType: #Overriding this property to have correct payload response examples + type: string + example: SHIPMENT + nullable: false + enum: + - SHIPMENT + shipmentInformationTypeCode: + $ref: '#/components/schemas/shipmentInformationTypeCode' + required: + - shipmentInformationTypeCode \ No newline at end of file diff --git a/components/transportEquipmentEvent.yaml b/components/transportEquipmentEvent.yaml new file mode 100644 index 0000000..b4c53e5 --- /dev/null +++ b/components/transportEquipmentEvent.yaml @@ -0,0 +1,37 @@ +transportEquipmentEvent: + description: The transport equipment event entity is a specialization of the event entity to support specification of data that applies to both transport and equipment events. + allOf: + - $ref: '#/components/schemas/event' + - type: object + properties: + eventType: #Overriding this property to have correct payload response examples + type: string + example: TRANSPORTEQUIPMENT + nullable: false + enum: + - TRANSPORTEQUIPMENT + transportReference: + $ref: '#/components/schemas/transportReference' + transportLegReference: + $ref: '#/components/schemas/transportLegReference' + equipmentReference: + $ref: '#/components/schemas/equipmentReference' + facilityTypeCode: + $ref: '#/components/schemas/facilityTypeCode' + UNLocationCode: + $ref: '#/components/schemas/UNLocationCode' + facilityCode: + $ref: '#/components/schemas/facilityCode' + otherFacility: + $ref: '#/components/schemas/otherFacility' + emptyIndicatorCode: + $ref: '#/components/schemas/emptyIndicatorCode' + modeOfTransportCode: + $ref: '#/components/schemas/modeOfTransportCode' + required: + - transportReference + - transportLegReference + - facilityTypeCode + - UNLocationCode + - facilityCode + - emptyIndicatorCode \ No newline at end of file diff --git a/components/transportEvent.yaml b/components/transportEvent.yaml new file mode 100644 index 0000000..a2d63e5 --- /dev/null +++ b/components/transportEvent.yaml @@ -0,0 +1,32 @@ +transportEvent: + description: The transport event entity is a specialization of the event entity to support specification of data that only applies to a transport event. + allOf: + - $ref: '#/components/schemas/event' + - type: object + properties: + eventType: #Overriding this property to have correct payload response examples + type: string + example: TRANSPORT + nullable: false + enum: + - TRANSPORT + transportReference: + $ref: '#/components/schemas/transportReference' + transportLegReference: + $ref: '#/components/schemas/transportLegReference' + facilityTypeCode: + $ref: '#/components/schemas/facilityTypeCode' + UNLocationCode: + $ref: '#/components/schemas/UNLocationCode' + facilityCode: + $ref: '#/components/schemas/facilityCode' + otherFacility: + $ref: '#/components/schemas/otherFacility' + modeOfTransportCode: + $ref: '#/components/schemas/modeOfTransportCode' + required: + - transportReference + - transportLegReference + - facilityTypeCode + - UNLocationCode + - facilityCode \ No newline at end of file diff --git a/electronic_data_interchange.yaml b/electronic_data_interchange.yaml new file mode 100644 index 0000000..02b9647 --- /dev/null +++ b/electronic_data_interchange.yaml @@ -0,0 +1,20055 @@ +--- +globals: + consumer: + - event: "#/definitions/Register" + - event: "#/definitions/EDIModel" + - event: "#/definitions/X12" + - event: "#/definitions/EDIFACT" + producer: + - event: "#/definitions/Initialize" + +definitions: + - event: "EDIModel" + name: "[Registration] register" + description: "MF registers itself at the CL" + - event: "X12" + name: "[Registration] register" + description: "MF registers itself at the CL" + - event: "EDIFACT" + name: "[Registration] register" + description: "MF registers itself at the CL" + +tags: +- name: Edifact + description: Translate, validate or acknowledge EDIFACT files +- name: EdiModel + description: Manage EDI transaction models +- name: X12 + description: Translate, validate or acknowledge X12 files +paths: ${} +components: + schemas: + TS837P: + required: + - AllNM1 + - BHT_BeginningOfHierarchicalTransaction + - Loop2000A + type: object + properties: + ST: + $ref: '#/components/schemas/ST' + BHT_BeginningOfHierarchicalTransaction: + $ref: '#/components/schemas/BHT_BeginningOfHierarchicalTransaction_8' + AllNM1: + $ref: '#/components/schemas/All_NM1_837P_6' + Loop2000A: + type: array + items: + $ref: '#/components/schemas/Loop_2000A_837P' + SE: + $ref: '#/components/schemas/SE' + Model: + type: string + x-freighttrust-message-id: "837" + x-freighttrust-message-standard: X12 + x-freighttrust-message-version: 005010X222A1 + ST: + required: + - TransactionSetControlNumber_02 + - TransactionSetIdentifierCode_01 + type: object + properties: + TransactionSetIdentifierCode_01: + maxLength: 3 + minLength: 3 + type: string + format: X12_AN + x-freighttrust-element-id: "143" + TransactionSetControlNumber_02: + maxLength: 9 + minLength: 4 + type: string + format: X12_AN + x-freighttrust-element-id: "329" + ImplementationConventionPreference_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1705" + x-freighttrust-segment-id: ST + X12_ID_1005_5: + type: string + enum: + - "0019" + X12_ID_353_7: + type: string + enum: + - "00" + - "18" + X12_ID_640_6: + type: string + enum: + - "31" + - CH + - RP + BHT_BeginningOfHierarchicalTransaction_8: + required: + - HierarchicalStructureCode_01 + - SubmitterTransactionIdentifier_03 + - TransactionSetCreationDate_04 + - TransactionSetCreationTime_05 + - TransactionSetPurposeCode_02 + - TransactionTypeCode_06 + type: object + properties: + HierarchicalStructureCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1005_5' + x-freighttrust-element-id: "1005" + TransactionSetPurposeCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_353_7' + x-freighttrust-element-id: "353" + SubmitterTransactionIdentifier_03: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + TransactionSetCreationDate_04: + maxLength: 8 + minLength: 8 + type: string + format: X12_DT + x-freighttrust-element-id: "373" + TransactionSetCreationTime_05: + maxLength: 8 + minLength: 4 + type: string + format: X12_TM + x-freighttrust-element-id: "337" + TransactionTypeCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_640_6' + x-freighttrust-element-id: "640" + x-freighttrust-segment-id: BHT + X12_ID_98_21: + type: string + enum: + - "41" + X12_ID_1065_2: + type: string + enum: + - "1" + - "2" + X12_ID_66_2: + type: string + enum: + - "46" + X12_ID_706_3: + type: string + enum: + - "01" + - "02" + - "03" + - "04" + - "05" + - "06" + - "07" + - "08" + - "09" + - "10" + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - "18" + - "19" + - "20" + - "21" + - "22" + - "23" + - "24" + - "25" + - "26" + - "27" + - "29" + - "30" + - "31" + - "32" + - "33" + - "34" + - "35" + - "36" + - "37" + - "38" + - "39" + - "40" + - "41" + - "42" + - "43" + - "44" + - "45" + - "46" + - "47" + - "48" + - "49" + - "50" + - "51" + - "52" + - "53" + - "54" + - "55" + - "56" + - "57" + - "58" + - "59" + - "60" + - "61" + - "62" + - "63" + - "64" + - "65" + - "66" + - "67" + - "68" + - "69" + - "70" + - "71" + - "72" + - "73" + - "74" + - "75" + - "76" + - "77" + - "78" + - "79" + - "80" + - "81" + - "82" + - "83" + - "84" + - "85" + - "86" + - "87" + - "88" + - "89" + - "90" + - "91" + - "92" + - "93" + - "94" + - "95" + - "96" + - "97" + - "98" + - "99" + - AA + - AB + - AC + - AD + - AE + - AF + - AG + - AH + - AI + - AJ + - AK + - AL + - AM + - AN + - AO + - AP + - AQ + - AR + - AS + - AT + - AU + - AV + - AW + - CP + - OP + - PI + X12_ID_98_19: + type: string + enum: + - "00" + - "001" + - "002" + - "003" + - "004" + - "005" + - "006" + - "007" + - "008" + - "01" + - "02" + - "03" + - "04" + - "05" + - "06" + - "07" + - "08" + - "09" + - 0A + - 0B + - 0D + - 0E + - 0F + - 0G + - 0H + - 0I + - 0J + - 0P + - "10" + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - "18" + - "19" + - 1A + - 1B + - 1C + - 1D + - 1E + - 1F + - 1G + - 1H + - 1I + - 1J + - 1K + - 1L + - 1M + - 1N + - 1O + - 1P + - 1Q + - 1R + - 1S + - 1T + - 1U + - 1V + - 1W + - 1X + - 1Y + - 1Z + - "20" + - "21" + - "22" + - "23" + - "24" + - "25" + - "26" + - "27" + - "28" + - "29" + - 2A + - 2B + - 2C + - 2D + - 2E + - 2F + - 2G + - 2H + - 2I + - 2J + - 2K + - 2L + - 2M + - 2N + - 2O + - 2P + - 2Q + - 2R + - 2S + - 2T + - 2U + - 2V + - 2W + - 2X + - 2Y + - 2Z + - "30" + - "31" + - "32" + - "33" + - "34" + - "35" + - "36" + - "37" + - "38" + - "39" + - 3A + - 3B + - 3C + - 3D + - 3E + - 3F + - 3G + - 3H + - 3I + - 3J + - 3K + - 3L + - 3M + - 3N + - 3O + - 3P + - 3Q + - 3R + - 3S + - 3T + - 3U + - 3V + - 3W + - 3X + - 3Y + - 3Z + - "40" + - "41" + - "42" + - "43" + - "44" + - "45" + - "46" + - "47" + - "48" + - "49" + - 4A + - 4B + - 4C + - 4D + - 4E + - 4F + - 4G + - 4H + - 4I + - 4J + - 4K + - 4L + - 4M + - 4N + - 4O + - 4P + - 4Q + - 4R + - 4S + - 4T + - 4U + - 4V + - 4W + - 4X + - 4Y + - 4Z + - "50" + - "51" + - "52" + - "53" + - "54" + - "55" + - "56" + - "57" + - "58" + - "59" + - 5A + - 5B + - 5C + - 5D + - 5E + - 5F + - 5G + - 5H + - 5I + - 5J + - 5K + - 5L + - 5M + - 5N + - 5O + - 5P + - 5Q + - 5R + - 5S + - 5T + - 5U + - 5V + - 5W + - 5X + - 5Y + - 5Z + - "60" + - "61" + - "62" + - "63" + - "64" + - "65" + - "66" + - "67" + - "68" + - "69" + - 6A + - 6B + - 6C + - 6D + - 6E + - 6F + - 6G + - 6H + - 6I + - 6J + - 6K + - 6L + - 6M + - 6N + - 6O + - 6P + - 6Q + - 6R + - 6S + - 6T + - 6U + - 6V + - 6W + - 6X + - 6Y + - 6Z + - "70" + - "71" + - "72" + - "73" + - "74" + - "75" + - "76" + - "77" + - "78" + - "79" + - 7A + - 7B + - 7C + - 7D + - 7E + - 7F + - 7G + - 7H + - 7I + - 7J + - 7K + - 7L + - 7M + - 7N + - 7O + - 7P + - 7Q + - 7R + - 7S + - 7T + - 7U + - 7V + - 7W + - 7X + - 7Y + - 7Z + - "80" + - "81" + - "82" + - "83" + - "84" + - "85" + - "86" + - "87" + - "88" + - "89" + - 8A + - 8B + - 8C + - 8D + - 8E + - 8F + - 8G + - 8H + - 8I + - 8J + - 8K + - 8L + - 8M + - 8N + - 8O + - 8P + - 8Q + - 8R + - 8S + - 8T + - 8U + - 8V + - 8W + - 8X + - 8Y + - "90" + - "91" + - "92" + - "93" + - "94" + - "95" + - "96" + - "97" + - "98" + - "99" + - 9A + - 9B + - 9C + - 9D + - 9E + - 9F + - 9G + - 9H + - 9I + - 9J + - 9K + - 9L + - 9N + - 9O + - 9P + - 9Q + - 9R + - 9S + - 9T + - 9U + - 9V + - 9W + - 9X + - 9Y + - 9Z + - A1 + - A2 + - A3 + - A4 + - A5 + - A6 + - A7 + - A8 + - A9 + - AA + - AA1 + - AA2 + - AA3 + - AA4 + - AA5 + - AA6 + - AA7 + - AA8 + - AA9 + - AAA + - AAB + - AAC + - AAD + - AAE + - AAF + - AAG + - AAH + - AAI + - AAJ + - AAK + - AAL + - AAM + - AAN + - AAO + - AAP + - AAQ + - AAS + - AAT + - AAU + - AAV + - AAW + - AB + - AB1 + - AB2 + - AB3 + - AB4 + - AB5 + - AB6 + - AB7 + - AB8 + - AB9 + - ABB + - ABC + - ABD + - ABE + - ABF + - ABG + - ABH + - ABI + - ABJ + - ABK + - ABL + - ABM + - ABN + - ABO + - ABP + - ABQ + - ABR + - ABS + - ABT + - ABU + - ABV + - ABW + - ABX + - AC + - AC1 + - AC2 + - AC3 + - ACB + - ACC + - ACE + - ACF + - ACG + - ACH + - ACI + - ACJ + - ACK + - ACL + - ACM + - ACN + - ACO + - ACP + - ACQ + - ACR + - ACS + - ACT + - ACU + - ACV + - ACW + - ACX + - ACY + - ACZ + - AD + - ADA + - ADB + - ADC + - ADD + - ADE + - ADF + - ADH + - ADJ + - ADK + - ADL + - ADM + - ADN + - ADO + - ADP + - ADQ + - ADR + - ADS + - ADT + - ADU + - ADV + - ADW + - ADX + - ADY + - ADZ + - AE + - AEA + - AEB + - AEC + - AED + - AEE + - AEF + - AEG + - AEI + - AEJ + - AEK + - AEL + - AF + - AG + - AH + - AHM + - AI + - AJ + - AK + - AL + - ALA + - ALO + - AM + - AN + - AO + - AP + - APR + - AQ + - AR + - AS + - AT + - ATA + - AU + - AUO + - AV + - AW + - AX + - AY + - AZ + - B1 + - B2 + - B3 + - B4 + - B5 + - B6 + - B7 + - B8 + - B9 + - BA + - BAL + - BB + - BC + - BD + - BE + - BF + - BG + - BH + - BI + - BJ + - BK + - BKR + - BL + - BLD + - BLT + - BM + - BN + - BO + - BOW + - BP + - BQ + - BR + - BRN + - BS + - BT + - BU + - BUS + - BV + - BW + - BX + - BY + - BZ + - C0 + - C1 + - C2 + - C3 + - C4 + - C4A + - C5 + - C6 + - C7 + - C8 + - C9 + - CA + - CB + - CC + - CD + - CE + - CF + - CG + - CH + - CHA + - CI + - CJ + - CK + - CL + - CLT + - CM + - CMW + - CN + - CNP + - CNR + - CNS + - CO + - COD + - COL + - COM + - COR + - CP + - CQ + - CR + - CRW + - CS + - CT + - CU + - CV + - CW + - CX + - CY + - CZ + - D1 + - D2 + - D3 + - D4 + - D5 + - D6 + - D7 + - D8 + - D9 + - DA + - DAM + - DB + - DC + - DCC + - DD + - DE + - DF + - DG + - DH + - DI + - DIR + - DJ + - DK + - DL + - DM + - DN + - DO + - DP + - DQ + - DR + - DS + - DT + - DU + - DV + - DW + - DX + - DY + - DZ + - E0 + - E1 + - E2 + - E3 + - E4 + - E5 + - E6 + - E7 + - E8 + - E9 + - EA + - EAA + - EAB + - EAD + - EAE + - EAF + - EAG + - EAH + - EAI + - EAJ + - EAK + - EAL + - EAM + - EAN + - EAO + - EAP + - EAQ + - EAR + - EAS + - EAT + - EAU + - EAV + - EAW + - EAX + - EAY + - EAZ + - EB + - EBA + - EBB + - EBC + - EBD + - EBE + - EBF + - EBG + - EBH + - EBI + - EBJ + - EBK + - EBL + - EBM + - EBN + - EBO + - EBP + - EBQ + - EBR + - EBS + - EC + - ED + - EE + - EF + - EG + - EH + - EI + - EJ + - EK + - EL + - EM + - EN + - ENR + - EO + - EP + - EQ + - ER + - ET + - EU + - EV + - EW + - EX + - EXS + - EY + - EZ + - F1 + - F2 + - F3 + - F4 + - F5 + - F6 + - F7 + - F8 + - F9 + - FA + - FB + - FC + - FD + - FE + - FF + - FG + - FGT + - FH + - FI + - FJ + - FL + - FM + - FN + - FO + - FP + - FQ + - FR + - FRL + - FS + - FSI + - FSR + - FT + - FU + - FV + - FW + - FX + - FY + - FZ + - G0 + - G1 + - G2 + - G3 + - G5 + - G6 + - G7 + - G8 + - G9 + - GA + - GB + - GBA + - GBO + - GBP + - GC + - GD + - GE + - GF + - GG + - GH + - GI + - GIR + - GJ + - GK + - GL + - GM + - GN + - GO + - GP + - GQ + - GR + - GS + - GT + - GU + - GV + - GW + - GX + - GY + - GZ + - H1 + - H2 + - H3 + - H5 + - H6 + - H7 + - H9 + - HA + - HB + - HC + - HD + - HE + - HF + - HG + - HH + - HI + - HJ + - HK + - HL + - HM + - HMI + - HN + - HO + - HOM + - HON + - HP + - HQ + - HR + - HS + - HT + - HU + - HV + - HW + - HX + - HY + - HZ + - I1 + - I3 + - I4 + - I9 + - IA + - IAA + - IAC + - IAD + - IAE + - IAF + - IAG + - IAH + - IAI + - IAK + - IAL + - IAM + - IAN + - IAO + - IAP + - IAQ + - IAR + - IAS + - IAT + - IAU + - IAV + - IAW + - IAY + - IAZ + - IB + - IC + - ICP + - ID + - IE + - IF + - IG + - II + - IJ + - IK + - IL + - IM + - IMM + - IN + - INT + - INV + - IO + - IP + - IQ + - IR + - IS + - IT + - IU + - IV + - J1 + - J2 + - J3 + - J4 + - J5 + - J6 + - J7 + - J8 + - J9 + - JA + - JB + - JC + - JD + - JE + - JF + - JG + - JH + - JI + - JJ + - JK + - JL + - JM + - JN + - JO + - JP + - JQ + - JR + - JS + - JT + - JU + - JV + - JW + - JX + - JY + - JZ + - K1 + - K2 + - K3 + - K4 + - K5 + - K6 + - K7 + - K8 + - K9 + - KA + - KB + - KC + - KD + - KE + - KF + - KG + - KH + - KI + - KJ + - KK + - KL + - KM + - KN + - KO + - KP + - KQ + - KR + - KS + - KT + - KU + - KV + - KW + - KX + - KY + - KZ + - L1 + - L2 + - L3 + - L5 + - L8 + - L9 + - LA + - LB + - LC + - LCN + - LD + - LE + - LF + - LG + - LGS + - LH + - LI + - LJ + - LK + - LL + - LM + - LN + - LO + - LP + - LQ + - LR + - LS + - LT + - LU + - LV + - LW + - LY + - LYM + - LYN + - LYO + - LYP + - LZ + - M1 + - M2 + - M3 + - M4 + - M5 + - M6 + - M7 + - M8 + - M9 + - MA + - MB + - MC + - MD + - ME + - MF + - MG + - MH + - MI + - MJ + - MK + - ML + - MM + - MN + - MO + - MP + - MQ + - MR + - MS + - MSC + - MT + - MTR + - MU + - MV + - MW + - MX + - MY + - MZ + - N1 + - N2 + - N3 + - N4 + - N5 + - N6 + - N7 + - N8 + - N9 + - NB + - NC + - NCT + - ND + - NE + - NF + - NG + - NH + - NI + - NJ + - NK + - NL + - NM + - NN + - NP + - NPC + - NQ + - NR + - NS + - NT + - NU + - NV + - NW + - NX + - NY + - NZ + - O1 + - O2 + - O3 + - O4 + - O5 + - O6 + - O7 + - O8 + - OA + - OB + - OC + - OD + - OE + - OF + - OG + - OH + - OI + - OL + - OM + - "ON" + - OO + - OP + - OR + - ORI + - OS + - OSH + - OT + - OU + - OUC + - OV + - OW + - OX + - OY + - OZ + - P0 + - P1 + - P2 + - P3 + - P4 + - P5 + - P6 + - P7 + - P8 + - P9 + - PA + - PB + - PC + - PD + - PE + - PF + - PG + - PH + - PI + - PIC + - PJ + - PK + - PL + - PLC + - PLR + - PM + - PMC + - PMF + - PMG + - PN + - PO + - PP + - PPC + - PPS + - PQ + - PR + - PRE + - PRO + - PRP + - PS + - PT + - PU + - PUR + - PV + - PW + - PX + - PY + - PZ + - Q1 + - Q2 + - Q3 + - Q4 + - Q5 + - Q6 + - Q7 + - Q8 + - Q9 + - QA + - QB + - QC + - QD + - QE + - QF + - QG + - QH + - QI + - QJ + - QK + - QL + - QM + - QN + - QO + - QP + - QQ + - QR + - QS + - QT + - QU + - QV + - QW + - QX + - QY + - QZ + - R0 + - R1 + - R2 + - R3 + - R4 + - R5 + - R6 + - R7 + - R8 + - R9 + - RA + - RB + - RC + - RCR + - RD + - REC + - RF + - RG + - RGA + - RH + - RI + - RJ + - RK + - RL + - RM + - RN + - RO + - RP + - RQ + - RR + - RR2 + - RR3 + - RS + - RT + - RU + - RV + - RW + - RX + - RY + - RZ + - S0 + - S1 + - S2 + - S3 + - S4 + - S5 + - S6 + - S7 + - S8 + - S9 + - SA + - SB + - SC + - SD + - SE + - SEP + - SF + - SG + - SH + - SI + - SIC + - SIP + - SJ + - SK + - SL + - SM + - SN + - SNP + - SO + - SP + - SQ + - SR + - SS + - ST + - STC + - SU + - SUS + - SV + - SW + - SX + - SY + - SZ + - T1 + - T2 + - T3 + - T4 + - T6 + - T8 + - T9 + - TA + - TB + - TC + - TD + - TE + - TEC + - TF + - TG + - TH + - TI + - TJ + - TK + - TL + - TM + - TN + - TO + - TOW + - TP + - TPM + - TQ + - TR + - TS + - TSD + - TSE + - TSR + - TT + - TTP + - TU + - TV + - TW + - TX + - TY + - TZ + - U1 + - U2 + - U3 + - U4 + - U5 + - U6 + - U7 + - U8 + - U9 + - UA + - UB + - UC + - UD + - UE + - UF + - UG + - UH + - UI + - UJ + - UK + - UL + - UM + - UN + - UO + - UP + - UQ + - UR + - US + - UT + - UU + - UW + - UX + - UY + - UZ + - V1 + - V2 + - V3 + - V4 + - V5 + - V6 + - V8 + - V9 + - VA + - VB + - VC + - VD + - VE + - VER + - VF + - VG + - VH + - VI + - VIC + - VJ + - VK + - VL + - VM + - VN + - VO + - VP + - VQ + - VR + - VS + - VT + - VU + - VV + - VW + - VX + - VY + - W1 + - W2 + - W3 + - W4 + - W8 + - W9 + - WA + - WB + - WC + - WD + - WE + - WF + - WG + - WH + - WI + - WJ + - WL + - WN + - WO + - WP + - WR + - WS + - WT + - WU + - WV + - WW + - WX + - WY + - WZ + - X1 + - X2 + - X3 + - X4 + - X5 + - X6 + - X7 + - X8 + - XA + - XC + - XD + - XE + - XF + - XG + - XH + - XI + - XJ + - XK + - XL + - XM + - XN + - XO + - XP + - XQ + - XR + - XS + - XT + - XU + - XV + - XW + - XX + - XY + - XZ + - Y2 + - YA + - YB + - YC + - YD + - YE + - YF + - YG + - YH + - YI + - YJ + - YK + - YL + - YM + - YN + - YO + - YP + - YQ + - YR + - YS + - YT + - YU + - YV + - YW + - YX + - YY + - YZ + - Z1 + - Z2 + - Z3 + - Z4 + - Z5 + - Z6 + - Z7 + - Z8 + - Z9 + - ZA + - ZB + - ZC + - ZD + - ZE + - ZF + - ZG + - ZH + - ZJ + - ZK + - ZL + - ZM + - ZN + - ZO + - ZP + - ZQ + - ZR + - ZS + - ZT + - ZU + - ZV + - ZW + - ZX + - ZY + - ZZ + NM1_InformationReceiverName_4: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + - IdentificationCodeQualifier_08 + - ResponseContactIdentifier_09 + - ResponseContactLastorOrganizationName_03 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_21' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_2' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_2' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + X12_ID_366_4: + type: string + enum: + - IC + X12_ID_365_18: + type: string + enum: + - EM + - FX + - TE + X12_ID_365_4: + type: string + enum: + - EM + - EX + - FX + - TE + PER_BillingProviderContactInformation: + required: + - CommunicationNumberQualifier_03 + - ContactFunctionCode_01 + - ResponseContactCommunicationNumber_04 + type: object + properties: + ContactFunctionCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_366_4' + x-freighttrust-element-id: "366" + ResponseContactName_02: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "93" + CommunicationNumberQualifier_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_365_18' + x-freighttrust-element-id: "365" + ResponseContactCommunicationNumber_04: + maxLength: 256 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "364" + CommunicationNumberQualifier_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_365_4' + x-freighttrust-element-id: "365" + ResponseContactCommunicationNumber_06: + maxLength: 256 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "364" + CommunicationNumberQualifier_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_365_4' + x-freighttrust-element-id: "365" + ResponseContactCommunicationNumber_08: + maxLength: 256 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "364" + ContactInquiryReference_09: + maxLength: 20 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "443" + x-freighttrust-syntax: + - P0304 + - P0506 + - P0708 + x-freighttrust-segment-id: PER + Loop_1000A_837P: + required: + - NM1_SubmitterName + - PER_SubmitterEDIContactInformation + type: object + properties: + NM1_SubmitterName: + $ref: '#/components/schemas/NM1_InformationReceiverName_4' + PER_SubmitterEDIContactInformation: + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/PER_BillingProviderContactInformation' + x-freighttrust-loop-id: 1000A + X12_ID_98_25: + type: string + enum: + - "40" + X12_ID_1065_3: + type: string + enum: + - "2" + NM1_ReceiverName: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + - IdentificationCodeQualifier_08 + - ResponseContactIdentifier_09 + - ResponseContactLastorOrganizationName_03 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_25' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_3' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_2' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + Loop_1000B_837P: + required: + - NM1_ReceiverName + type: object + properties: + NM1_ReceiverName: + $ref: '#/components/schemas/NM1_ReceiverName' + x-freighttrust-loop-id: 1000B + All_NM1_837P_6: + required: + - Loop1000A + - Loop1000B + type: object + properties: + Loop1000A: + $ref: '#/components/schemas/Loop_1000A_837P' + Loop1000B: + $ref: '#/components/schemas/Loop_1000B_837P' + X12_ID_735_8: + type: string + enum: + - "20" + X12_ID_736_3: + type: string + enum: + - "1" + HL_BillingProviderHierarchicalLevel: + required: + - HierarchicalChildCode_04 + - HierarchicalIDNumber_01 + - HierarchicalLevelCode_03 + type: object + properties: + HierarchicalIDNumber_01: + maxLength: 12 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "628" + HierarchicalParentIDNumber_02: + maxLength: 12 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "734" + HierarchicalLevelCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_735_8' + x-freighttrust-element-id: "735" + HierarchicalChildCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_736_3' + x-freighttrust-element-id: "736" + x-freighttrust-segment-id: HL + X12_ID_1221_10: + type: string + enum: + - BI + X12_ID_128_35: + type: string + enum: + - PXC + X12_ID_1222: + type: string + enum: + - DEN + - DGP + - END + - IHG + - OPY + - ORT + - OSY + - PDT + - PED + - PHD + - PST + X12_ID_559: + type: string + enum: + - "10" + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - "18" + - "19" + - "20" + - "21" + - "22" + - "23" + - "24" + - "25" + - "26" + - "27" + - "28" + - "29" + - "30" + - "31" + - "32" + - "33" + - "34" + - "35" + - "36" + - "37" + - "38" + - "39" + - "40" + - "41" + - "42" + - "43" + - "44" + - "45" + - "46" + - "47" + - "48" + - "49" + - "50" + - "51" + - "52" + - "53" + - "54" + - "55" + - "56" + - "57" + - "58" + - "59" + - "60" + - "61" + - "62" + - "64" + - "65" + - "66" + - "93" + - "94" + - A1 + - A2 + - A3 + - A4 + - AA + - AB + - AC + - AD + - AE + - AF + - AG + - AH + - AJ + - AL + - AM + - AP + - AQ + - AR + - AS + - AT + - AW + - AX + - AY + - BA + - BE + - BF + - BI + - CA + - CB + - CC + - CE + - CI + - CL + - CM + - CO + - CP + - CR + - CS + - CU + - CX + - DA + - DD + - DE + - DF + - DH + - DI + - DL + - DN + - DO + - DR + - DS + - DX + - DY + - DZ + - EI + - EP + - ES + - ET + - EU + - EX + - FA + - FC + - FD + - FG + - FH + - FI + - GC + - GI + - GS + - GU + - HC + - HF + - HI + - HS + - HU + - IA + - IB + - IC + - IM + - IN + - IS + - JA + - LA + - LB + - LI + - MA + - MB + - MC + - ME + - MI + - MP + - MS + - MV + - NA + - NB + - NC + - NE + - NF + - NG + - NI + - NP + - NR + - NS + - NT + - NU + - NW + - OI + - OP + - OS + - PA + - PC + - PI + - RN + - SA + - SE + - SL + - SP + - ST + - TA + - TB + - TC + - TD + - TI + - TM + - TP + - TR + - TX + - UA + - UC + - UI + - UL + - UN + - UT + - VI + - WH + - ZZ + X12_ID_1073_2: + type: string + enum: + - "N" + - U + - W + - "Y" + C035_ProviderSpecialtyInformation: + required: + - ProviderSpecialtyCode_01 + type: object + properties: + ProviderSpecialtyCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1222' + x-freighttrust-element-id: "1222" + AgencyQualifierCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_559' + x-freighttrust-element-id: "559" + YesNoConditionorResponseCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_2' + x-freighttrust-element-id: "1073" + x-freighttrust-composite-id: C035 + X12_ID_1223: + type: string + enum: + - "001" + - "002" + - "003" + - "004" + - "005" + - "006" + - "007" + - "008" + PRV_BillingProviderSpecialtyInformation: + required: + - ProviderCode_01 + - ProviderTaxonomyCode_03 + - ReferenceIdentificationQualifier_02 + type: object + properties: + ProviderCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1221_10' + x-freighttrust-element-id: "1221" + ReferenceIdentificationQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_35' + x-freighttrust-element-id: "128" + ProviderTaxonomyCode_03: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + StateorProvinceCode_04: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "156" + ProviderSpecialtyInformation_05: + $ref: '#/components/schemas/C035_ProviderSpecialtyInformation' + ProviderOrganizationCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1223' + x-freighttrust-element-id: "1223" + x-freighttrust-syntax: + - P0203 + x-freighttrust-segment-id: PRV + X12_ID_98_31: + type: string + enum: + - "85" + X12_ID_669: + type: string + enum: + - IMF + - LNF + - LNS + - NYC + - PHI + - ZUR + X12_ID_374_51: + type: string + enum: + - "001" + - "002" + - "003" + - "004" + - "005" + - "006" + - "007" + - "008" + - "009" + - "010" + - "011" + - "012" + - "013" + - "014" + - "015" + - "016" + - "017" + - "018" + - "019" + - "020" + - "021" + - "022" + - "023" + - "024" + - "025" + - "026" + - "027" + - "028" + - "029" + - "030" + - "031" + - "032" + - "033" + - "034" + - "035" + - "036" + - "037" + - "038" + - "039" + - "040" + - "041" + - "042" + - "043" + - "044" + - "045" + - "046" + - "047" + - "048" + - "049" + - "050" + - "051" + - "052" + - "053" + - "054" + - "055" + - "056" + - "057" + - "058" + - "059" + - "060" + - "061" + - "062" + - "063" + - "064" + - "065" + - "066" + - "067" + - "068" + - "069" + - "070" + - "071" + - "072" + - "073" + - "074" + - "075" + - "076" + - "077" + - "078" + - "079" + - "080" + - "081" + - "082" + - "083" + - "084" + - "085" + - "086" + - "087" + - "088" + - "089" + - "090" + - "091" + - "092" + - "093" + - "094" + - "095" + - "096" + - "097" + - "098" + - "099" + - "100" + - "101" + - "102" + - "103" + - "104" + - "105" + - "106" + - "107" + - "108" + - "109" + - "110" + - "111" + - "112" + - "113" + - "114" + - "115" + - "116" + - "118" + - "119" + - "120" + - "121" + - "122" + - "124" + - "125" + - "126" + - "127" + - "128" + - "129" + - "130" + - "131" + - "132" + - "133" + - "134" + - "135" + - "136" + - "137" + - "138" + - "139" + - "140" + - "141" + - "142" + - "143" + - "144" + - "145" + - "146" + - "147" + - "148" + - "149" + - "150" + - "151" + - "152" + - "153" + - "154" + - "155" + - "156" + - "157" + - "158" + - "159" + - "160" + - "161" + - "162" + - "163" + - "164" + - "165" + - "166" + - "167" + - "168" + - "169" + - "170" + - "171" + - "172" + - "173" + - "174" + - "175" + - "176" + - "177" + - "178" + - "179" + - "180" + - "181" + - "182" + - "183" + - "184" + - "185" + - "186" + - "187" + - "188" + - "189" + - "190" + - "191" + - "192" + - "193" + - "194" + - "195" + - "196" + - "197" + - "198" + - "199" + - "200" + - "201" + - "202" + - "203" + - "204" + - "205" + - "206" + - "207" + - "208" + - "209" + - "210" + - "211" + - "212" + - "213" + - "214" + - "215" + - "216" + - "217" + - "218" + - "219" + - "220" + - "221" + - "222" + - "223" + - "224" + - "225" + - "226" + - "227" + - "228" + - "229" + - "230" + - "231" + - "232" + - "233" + - "234" + - "235" + - "236" + - "237" + - "238" + - "239" + - "240" + - "241" + - "242" + - "243" + - "244" + - "245" + - "246" + - "247" + - "248" + - "249" + - "250" + - "251" + - "252" + - "253" + - "254" + - "255" + - "256" + - "257" + - "258" + - "259" + - "260" + - "261" + - "262" + - "263" + - "264" + - "265" + - "266" + - "267" + - "268" + - "269" + - "270" + - "271" + - "272" + - "273" + - "274" + - "275" + - "276" + - "277" + - "278" + - "279" + - "280" + - "281" + - "282" + - "283" + - "284" + - "285" + - "286" + - "287" + - "288" + - "289" + - "290" + - "291" + - "292" + - "293" + - "294" + - "295" + - "296" + - "297" + - "298" + - "299" + - "300" + - "301" + - "302" + - "303" + - "304" + - "305" + - "306" + - "307" + - "308" + - "309" + - "310" + - "311" + - "312" + - "313" + - "314" + - "315" + - "316" + - "317" + - "318" + - "319" + - "320" + - "321" + - "322" + - "323" + - "324" + - "325" + - "326" + - "327" + - "328" + - "329" + - "330" + - "331" + - "332" + - "333" + - "334" + - "335" + - "336" + - "337" + - "338" + - "339" + - "340" + - "341" + - "342" + - "343" + - "344" + - "345" + - "346" + - "347" + - "348" + - "349" + - "350" + - "351" + - "352" + - "353" + - "354" + - "355" + - "356" + - "357" + - "358" + - "359" + - "360" + - "361" + - "362" + - "363" + - "364" + - "365" + - "366" + - "367" + - "368" + - "369" + - "370" + - "371" + - "372" + - "373" + - "374" + - "375" + - "376" + - "377" + - "378" + - "379" + - "380" + - "381" + - "382" + - "383" + - "384" + - "385" + - "386" + - "387" + - "388" + - "389" + - "390" + - "391" + - "392" + - "393" + - "394" + - "395" + - "396" + - "397" + - "398" + - "399" + - "400" + - "401" + - "402" + - "403" + - "404" + - "405" + - "406" + - "408" + - "409" + - "410" + - "411" + - "412" + - "413" + - "414" + - "415" + - "416" + - "417" + - "418" + - "419" + - "420" + - "421" + - "422" + - "423" + - "424" + - "425" + - "426" + - "427" + - "428" + - "429" + - "430" + - "431" + - "432" + - "433" + - "434" + - "435" + - "436" + - "437" + - "438" + - "439" + - "440" + - "441" + - "442" + - "443" + - "444" + - "445" + - "446" + - "447" + - "448" + - "449" + - "450" + - "451" + - "452" + - "453" + - "454" + - "455" + - "456" + - "457" + - "458" + - "459" + - "460" + - "461" + - "462" + - "463" + - "464" + - "465" + - "466" + - "467" + - "468" + - "469" + - "470" + - "471" + - "472" + - "473" + - "474" + - "475" + - "476" + - "477" + - "478" + - "479" + - "480" + - "481" + - "482" + - "483" + - "484" + - "485" + - "486" + - "487" + - "488" + - "489" + - "490" + - "491" + - "492" + - "493" + - "494" + - "495" + - "496" + - "497" + - "498" + - "499" + - "500" + - "501" + - "502" + - "503" + - "504" + - "505" + - "506" + - "507" + - "508" + - "509" + - "510" + - "511" + - "512" + - "513" + - "514" + - "515" + - "516" + - "517" + - "518" + - "519" + - "520" + - "521" + - "522" + - "523" + - "524" + - "525" + - "526" + - "527" + - "528" + - "529" + - "530" + - "531" + - "532" + - "533" + - "534" + - "535" + - "536" + - "537" + - "538" + - "539" + - "540" + - "541" + - "542" + - "543" + - "544" + - "545" + - "546" + - "547" + - "548" + - "549" + - "550" + - "551" + - "552" + - "553" + - "554" + - "555" + - "556" + - "557" + - "558" + - "559" + - "560" + - "561" + - "562" + - "563" + - "564" + - "565" + - "566" + - "567" + - "568" + - "569" + - "570" + - "571" + - "572" + - "573" + - "574" + - "575" + - "576" + - "577" + - "578" + - "579" + - "580" + - "581" + - "582" + - "583" + - "584" + - "585" + - "586" + - "587" + - "589" + - "590" + - "591" + - "592" + - "593" + - "594" + - "595" + - "596" + - "597" + - "598" + - "599" + - "600" + - "601" + - "602" + - "603" + - "604" + - "606" + - "607" + - "608" + - "609" + - "610" + - "611" + - "612" + - "613" + - "614" + - "615" + - "616" + - "617" + - "618" + - "619" + - "620" + - "621" + - "622" + - "623" + - "624" + - "625" + - "626" + - "627" + - "629" + - "630" + - "631" + - "632" + - "633" + - "634" + - "635" + - "636" + - "637" + - "638" + - "640" + - "641" + - "642" + - "643" + - "644" + - "646" + - "647" + - "648" + - "649" + - "650" + - "651" + - "652" + - "653" + - "655" + - "656" + - "657" + - "658" + - "659" + - "660" + - "661" + - "662" + - "663" + - "664" + - "665" + - "666" + - "667" + - "668" + - "669" + - "670" + - "671" + - "672" + - "673" + - "674" + - "675" + - "681" + - "682" + - "683" + - "684" + - "685" + - "686" + - "687" + - "688" + - "689" + - "690" + - "691" + - "692" + - "693" + - "694" + - "695" + - "696" + - "697" + - "699" + - "700" + - "701" + - "702" + - "703" + - "704" + - "705" + - "706" + - "707" + - "708" + - "709" + - "710" + - "711" + - "712" + - "713" + - "714" + - "715" + - "716" + - "717" + - "718" + - "719" + - "720" + - "721" + - "722" + - "723" + - "724" + - "725" + - "726" + - "727" + - "728" + - "729" + - "730" + - "731" + - "732" + - "733" + - "734" + - "736" + - "737" + - "738" + - "739" + - "740" + - "741" + - "742" + - "743" + - "744" + - "745" + - "746" + - "747" + - "748" + - "749" + - "750" + - "751" + - "752" + - "753" + - "754" + - "755" + - "756" + - "757" + - "758" + - "759" + - "760" + - "761" + - "762" + - "764" + - "765" + - "766" + - "769" + - "770" + - "771" + - "772" + - "773" + - "774" + - "775" + - "776" + - "777" + - "778" + - "779" + - "780" + - "781" + - "782" + - "783" + - "784" + - "785" + - "786" + - "787" + - "788" + - "789" + - "790" + - "791" + - "792" + - "793" + - "794" + - "795" + - "796" + - "797" + - "798" + - "799" + - "800" + - "801" + - "802" + - "803" + - "804" + - "805" + - "806" + - "807" + - "808" + - "809" + - "810" + - "811" + - "812" + - "813" + - "814" + - "815" + - "816" + - "817" + - "818" + - "819" + - "820" + - "821" + - "822" + - "823" + - "824" + - "825" + - "826" + - "827" + - "828" + - "830" + - "831" + - "832" + - "840" + - "841" + - "842" + - "843" + - "844" + - "845" + - "846" + - "847" + - "848" + - "849" + - "850" + - "851" + - "853" + - "854" + - "855" + - "856" + - "857" + - "858" + - "859" + - "860" + - "861" + - "862" + - "863" + - "864" + - "865" + - "866" + - "867" + - "868" + - "869" + - "870" + - "871" + - "872" + - "873" + - "874" + - "875" + - "876" + - "877" + - "878" + - "879" + - "880" + - "881" + - "882" + - "883" + - "884" + - "885" + - "900" + - "901" + - "903" + - "904" + - "905" + - "906" + - "907" + - "908" + - "909" + - "910" + - "911" + - "912" + - "913" + - "914" + - "915" + - "916" + - "917" + - "918" + - "919" + - "920" + - "921" + - "922" + - "923" + - "924" + - "925" + - "926" + - "927" + - "928" + - "930" + - "931" + - "932" + - "933" + - "934" + - "935" + - "936" + - "937" + - "938" + - "939" + - "940" + - "941" + - "942" + - "943" + - "944" + - "945" + - "946" + - "947" + - "948" + - "949" + - "950" + - "951" + - "952" + - "953" + - "954" + - "955" + - "956" + - "957" + - "960" + - "961" + - "962" + - "963" + - "964" + - "965" + - "966" + - "967" + - "968" + - "969" + - "970" + - "971" + - "972" + - "973" + - "974" + - "975" + - "976" + - "977" + - "978" + - "979" + - "980" + - "981" + - "982" + - "983" + - "984" + - "985" + - "986" + - "987" + - "988" + - "989" + - "990" + - "992" + - "993" + - "994" + - "995" + - "996" + - "997" + - "998" + - "999" + - AA1 + - AA2 + - AA3 + - AA4 + - AA5 + - AA6 + - AA7 + - AA8 + - AA9 + - AAA + - AAB + - AAC + - AAD + - AAE + - AAF + - AAG + - AAH + - AAI + - AAJ + - AAK + - AAL + - AAM + - AAN + - AAO + - AAP + - AAQ + - AAR + - AAS + - AAT + - AAU + - AAV + - AAW + - AAX + - AAY + - AAZ + - AB1 + - AB2 + - AB3 + - AB4 + - AB5 + - AB6 + - AB7 + - AB8 + - AB9 + - ABA + - ABB + - ABC + - ABD + - ABE + - ABF + - ABG + - ABH + - ABI + - ABK + - ABL + - ABM + - ABN + - ABO + - ABP + - ABQ + - ABR + - ABS + - ABT + - ABU + - ABV + - ABW + - ABX + - ABY + - ACA + - ACB + - ACC + - ACD + - ACE + - ACF + - ACG + - ACH + - ACI + - ACJ + - ACK + - ACL + - ACM + - ACN + - ACO + - ACP + - ACQ + - ACR + - ACS + - ACT + - ACU + - ACV + - ACW + - ACX + - ACZ + - ADA + - ADB + - ADC + - ADD + - ADE + - ADF + - ADG + - ADH + - ADI + - ADJ + - ADK + - ADL + - ADM + - ADN + - ADR + - ADS + - ADT + - ADU + - ADV + - ADW + - ADX + - ADY + - AEA + - AEB + - AEC + - AED + - AEE + - AEF + - AEG + - AEH + - AEI + - AEK + - AEL + - AEM + - AEN + - AEO + - AEP + - AEQ + - AER + - AES + - AET + - AEU + - AEV + - AEW + - AEX + - AEY + - ARD + - AWH + - BAA + - BAB + - BAC + - BAD + - BAE + - BAF + - BAG + - BAH + - BAI + - BAJ + - BAK + - BAL + - BAM + - BAN + - BAO + - BAP + - BAQ + - BAR + - BIP + - CAD + - CCR + - CDD + - CDT + - CEA + - CEB + - CEC + - CED + - CEE + - CEF + - CEH + - CEJ + - CEK + - CEL + - CEM + - CEN + - CEO + - CLO + - CLU + - COM + - CON + - CRV + - CUR + - DAF + - DDO + - DEE + - DEL + - DET + - DFF + - DFS + - DIL + - DIP + - DIS + - DLC + - DOA + - DOD + - DOI + - DOR + - DSP + - DTC + - DTQ + - E01 + - E02 + - E03 + - E04 + - E05 + - E06 + - E07 + - ECD + - ECF + - ECS + - ECT + - EDA + - EDB + - EDC + - EDD + - EDE + - EDF + - EDG + - EDH + - EDI + - EDJ + - EDK + - EDL + - EDM + - EDN + - EDO + - EDP + - EKD + - EPP + - ESC + - ESF + - ESS + - EST + - ETP + - EXO + - EXP + - FFI + - FFO + - FIA + - FPE + - FPS + - GRD + - ICF + - IDG + - IFH + - III + - IMP + - INC + - INT + - IPS + - IVA + - KEV + - KEW + - LAM + - LAS + - LCC + - LEA + - LEL + - LIQ + - LLP + - LOG + - LPC + - LSC + - LTP + - MRR + - MSD + - NAM + - NFD + - NOD + - NRG + - NSD + - ORG + - PBC + - PCP + - PCS + - PDE + - PDR + - PDV + - PLS + - PPC + - PPD + - PPP + - PRD + - PRR + - PSA + - PSC + - PSF + - PTD + - PTO + - RAP + - RES + - RFD + - RFF + - RFO + - RNT + - RRM + - RRT + - RSD + - RSS + - RTO + - SCV + - SDD + - SFH + - STN + - SVA + - TSR + - TSS + - TST + - VAT + - VLU + - W01 + - W02 + - W03 + - W05 + - W06 + - W07 + - W08 + - W09 + - W10 + - W11 + - W12 + - W13 + - WAA + - WAY + - YXX + - YXY + - ZZZ + CUR_ForeignCurrencyInformation_3: + required: + - CurrencyCode_02 + - EntityIdentifierCode_01 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_31' + x-freighttrust-element-id: "98" + CurrencyCode_02: + maxLength: 3 + minLength: 3 + type: string + format: X12_AN + x-freighttrust-element-id: "100" + ExchangeRate_03: + maxLength: 10 + minLength: 4 + type: string + format: X12_R + x-freighttrust-element-id: "280" + EntityIdentifierCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + CurrencyCode_05: + maxLength: 3 + minLength: 3 + type: string + format: X12_AN + x-freighttrust-element-id: "100" + CurrencyMarketExchangeCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_669' + x-freighttrust-element-id: "669" + DateTimeQualifier_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_51' + x-freighttrust-element-id: "374" + Date_08: + maxLength: 8 + minLength: 8 + type: string + format: X12_DT + x-freighttrust-element-id: "373" + Time_09: + maxLength: 8 + minLength: 4 + type: string + format: X12_TM + x-freighttrust-element-id: "337" + DateTimeQualifier_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_51' + x-freighttrust-element-id: "374" + Date_11: + maxLength: 8 + minLength: 8 + type: string + format: X12_DT + x-freighttrust-element-id: "373" + Time_12: + maxLength: 8 + minLength: 4 + type: string + format: X12_TM + x-freighttrust-element-id: "337" + DateTimeQualifier_13: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_51' + x-freighttrust-element-id: "374" + Date_14: + maxLength: 8 + minLength: 8 + type: string + format: X12_DT + x-freighttrust-element-id: "373" + Time_15: + maxLength: 8 + minLength: 4 + type: string + format: X12_TM + x-freighttrust-element-id: "337" + DateTimeQualifier_16: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_51' + x-freighttrust-element-id: "374" + Date_17: + maxLength: 8 + minLength: 8 + type: string + format: X12_DT + x-freighttrust-element-id: "373" + Time_18: + maxLength: 8 + minLength: 4 + type: string + format: X12_TM + x-freighttrust-element-id: "337" + DateTimeQualifier_19: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_51' + x-freighttrust-element-id: "374" + Date_20: + maxLength: 8 + minLength: 8 + type: string + format: X12_DT + x-freighttrust-element-id: "373" + Time_21: + maxLength: 8 + minLength: 4 + type: string + format: X12_TM + x-freighttrust-element-id: "337" + x-freighttrust-syntax: + - C0807 + - C0907 + - L101112 + - C1110 + - C1210 + - L131415 + - C1413 + - C1513 + - L161718 + - C1716 + - C1816 + - L192021 + - C2019 + - C2119 + x-freighttrust-segment-id: CUR + X12_ID_66_7: + type: string + enum: + - XX + NM1_BillingProviderName_2: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + - ResponseContactLastorOrganizationName_03 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_31' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_2' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_7' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + N3_AdditionalPatientInformationContactAddress: + required: + - ResponseContactAddressLine_01 + type: object + properties: + ResponseContactAddressLine_01: + maxLength: 55 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "166" + ResponseContactAddressLine_02: + maxLength: 55 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "166" + x-freighttrust-segment-id: N3 + X12_ID_309_2: + type: string + enum: + - "10" + - "11" + - "12" + - "13" + - "14" + - "18" + - "19" + - "20" + - "21" + - "22" + - "27" + - "28" + - "29" + - "30" + - "31" + - "32" + - "33" + - "34" + - "35" + - "36" + - "38" + - "39" + - "40" + - "41" + - "42" + - "43" + - "44" + - "45" + - "46" + - "47" + - "48" + - "49" + - "50" + - "52" + - "53" + - "54" + - "55" + - "57" + - "58" + - "59" + - "60" + - "93" + - "94" + - A + - A1 + - AA + - AC + - AP + - AR + - B + - B1 + - BE + - BL + - BS + - C + - C2 + - CA + - CB + - CC + - CD + - CE + - CG + - CI + - CL + - CM + - CO + - CR + - CS + - CY + - D + - DC + - DE + - DL + - DO + - DP + - DR + - DT + - E + - EA + - EB + - EL + - F + - FA + - FE + - FF + - FI + - FR + - FS + - FT + - FV + - G + - GL + - H + - I + - IA + - IB + - IM + - IP + - IS + - IT + - J + - K + - KE + - KL + - KP + - L + - LO + - M + - MI + - MO + - MS + - MZ + - NS + - O + - OA + - OF + - OL + - OP + - OR + - OV + - P + - PA + - PB + - PC + - PD + - PE + - PF + - PG + - PH + - PL + - PM + - PO + - PP + - PQ + - PR + - PS + - PT + - PU + - PV + - PZ + - Q + - RA + - RC + - RE + - RG + - RJ + - RL + - RS + - RT + - SA + - SB + - SC + - SD + - SE + - SG + - SH + - SL + - SN + - SP + - SS + - ST + - SW + - TA + - TC + - TI + - TL + - TM + - TN + - TP + - TR + - TX + - UN + - UR + - UT + - VA + - VI + - VS + - W + - WF + - WH + - WI + - X1 + - ZN + - ZZ + N4_AdditionalPatientInformationContactCity: + required: + - AdditionalPatientInformationContactCityName_01 + type: object + properties: + AdditionalPatientInformationContactCityName_01: + maxLength: 30 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "19" + AdditionalPatientInformationContactStateCode_02: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "156" + AdditionalPatientInformationContactPostalZoneorZIPCode_03: + maxLength: 15 + minLength: 3 + type: string + format: X12_AN + x-freighttrust-element-id: "116" + CountryCode_04: + maxLength: 3 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "26" + LocationQualifier_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_309_2' + x-freighttrust-element-id: "309" + LocationIdentifier_06: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "310" + CountrySubdivisionCode_07: + maxLength: 3 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1715" + x-freighttrust-syntax: + - E0207 + - C0605 + - C0704 + x-freighttrust-segment-id: N4 + X12_ID_128_21: + type: string + enum: + - EI + - SY + X12_ID_128_20: + type: string + enum: + - "00" + - "01" + - 01A + - 01B + - 01C + - 01D + - 01E + - 01G + - 01H + - "02" + - "03" + - "04" + - "05" + - "06" + - "07" + - "08" + - "09" + - 0A + - 0B + - 0D + - 0E + - 0F + - 0G + - 0H + - 0I + - 0J + - 0K + - 0L + - 0M + - 0N + - 0P + - "10" + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - "18" + - "19" + - 1A + - 1B + - 1C + - 1D + - 1E + - 1F + - 1G + - 1H + - 1I + - 1J + - 1K + - 1L + - 1M + - 1N + - 1O + - 1P + - 1Q + - 1R + - 1S + - 1T + - 1U + - 1V + - 1W + - 1X + - 1Y + - 1Z + - "20" + - "21" + - "22" + - "23" + - "24" + - "25" + - "26" + - "27" + - "28" + - "29" + - 2A + - 2B + - 2C + - 2D + - 2E + - 2F + - 2G + - 2H + - 2I + - 2J + - 2K + - 2L + - 2M + - 2N + - 2O + - 2P + - 2Q + - 2R + - 2S + - 2T + - 2U + - 2V + - 2W + - 2X + - 2Y + - 2Z + - "30" + - "31" + - "32" + - "33" + - "34" + - "35" + - "36" + - "37" + - "38" + - "39" + - 3A + - 3B + - 3C + - 3D + - 3E + - 3F + - 3G + - 3H + - 3I + - 3J + - 3K + - 3L + - 3M + - 3N + - 3O + - 3P + - 3Q + - 3R + - 3S + - 3T + - 3U + - 3V + - 3W + - 3X + - 3Y + - 3Z + - "40" + - "41" + - "42" + - "43" + - "44" + - "45" + - "46" + - "47" + - "48" + - "49" + - 4A + - 4B + - 4C + - 4D + - 4E + - 4F + - 4G + - 4H + - 4I + - 4J + - 4K + - 4L + - 4M + - 4N + - 4O + - 4P + - 4Q + - 4R + - 4S + - 4T + - 4U + - 4V + - 4W + - 4X + - 4Y + - 4Z + - "50" + - "51" + - "52" + - "53" + - "54" + - "55" + - "56" + - "57" + - "58" + - "59" + - 5A + - 5B + - 5C + - 5D + - 5E + - 5F + - 5G + - 5H + - 5I + - 5J + - 5K + - 5L + - 5M + - 5N + - 5O + - 5P + - 5Q + - 5R + - 5S + - 5T + - 5U + - 5V + - 5W + - 5X + - 5Y + - 5Z + - "60" + - "61" + - "63" + - "64" + - "65" + - "66" + - "67" + - "68" + - "69" + - 6A + - 6B + - 6C + - 6D + - 6E + - 6F + - 6G + - 6H + - 6I + - 6J + - 6K + - 6L + - 6M + - 6N + - 6O + - 6P + - 6Q + - 6R + - 6S + - 6T + - 6U + - 6V + - 6X + - 6Y + - 6Z + - "70" + - "71" + - "72" + - "73" + - "74" + - "75" + - "76" + - "77" + - "78" + - "79" + - 7A + - 7B + - 7C + - 7D + - 7E + - 7F + - 7G + - 7H + - 7I + - 7J + - 7K + - 7L + - 7M + - 7N + - 7O + - 7P + - 7Q + - 7R + - 7S + - 7T + - 7U + - 7W + - 7X + - 7Y + - 7Z + - "80" + - "81" + - "82" + - "83" + - "84" + - "85" + - "86" + - "87" + - "88" + - "89" + - 8A + - 8B + - 8C + - 8D + - 8E + - 8F + - 8G + - 8H + - 8I + - 8J + - 8K + - 8L + - 8M + - 8N + - 8O + - 8P + - 8Q + - 8R + - 8S + - 8U + - 8V + - 8W + - 8X + - 8Y + - 8Z + - "90" + - "91" + - "92" + - "93" + - "94" + - "95" + - "96" + - "97" + - "98" + - "99" + - 9A + - 9B + - 9C + - 9D + - 9E + - 9F + - 9G + - 9H + - 9I + - 9J + - 9K + - 9L + - 9M + - 9N + - 9P + - 9Q + - 9R + - 9S + - 9T + - 9U + - 9V + - 9W + - 9X + - 9Y + - 9Z + - A0 + - A1 + - A2 + - A3 + - A4 + - A5 + - A7 + - A8 + - A9 + - AA + - AAA + - AAB + - AAC + - AAD + - AAE + - AAF + - AAG + - AAH + - AAI + - AAJ + - AAK + - AAL + - AAM + - AAN + - AAO + - AAP + - AAQ + - AAR + - AAS + - AAT + - AAU + - AAV + - AAW + - AAX + - AAY + - AAZ + - AB + - ABA + - ABB + - ABC + - ABD + - ABE + - ABF + - ABG + - ABH + - ABI + - ABJ + - ABK + - ABL + - ABM + - ABN + - ABO + - ABP + - ABQ + - ABR + - ABS + - ABT + - ABU + - ABV + - ABW + - ABX + - ABY + - ABZ + - AC + - ACA + - ACB + - ACC + - ACD + - ACE + - ACF + - ACG + - ACH + - ACI + - ACJ + - ACK + - ACL + - ACM + - ACN + - ACO + - ACP + - ACQ + - ACR + - ACS + - ACT + - ACU + - ACV + - ACW + - ACX + - ACY + - ACZ + - AD + - ADA + - ADB + - ADC + - ADD + - ADE + - ADF + - ADG + - ADH + - ADI + - ADJ + - ADK + - ADL + - ADM + - ADN + - ADO + - ADP + - ADQ + - ADR + - ADS + - ADT + - ADU + - ADV + - ADW + - ADX + - ADY + - ADZ + - AE + - AEA + - AEB + - AEC + - AED + - AEE + - AEF + - AEG + - AEH + - AEI + - AEJ + - AEK + - AEL + - AEM + - AEN + - AEO + - AEP + - AEQ + - AER + - AES + - AET + - AEU + - AEV + - AEX + - AEY + - AEZ + - AF + - AFA + - AFB + - AFC + - AFD + - AFE + - AFF + - AFG + - AFH + - AFI + - AFJ + - AFK + - AFL + - AFM + - AFN + - AFO + - AFP + - AFQ + - AFR + - AFS + - AFT + - AFU + - AFV + - AFW + - AFX + - AFY + - AFZ + - AG + - AGA + - AGB + - AGC + - AGD + - AGH + - AGI + - AGJ + - AGK + - AGL + - AGM + - AGN + - AGO + - AGP + - AGQ + - AH + - AHC + - AI + - AJ + - AK + - AL + - ALC + - ALG + - ALH + - ALI + - ALJ + - ALR + - ALS + - ALT + - AM + - AN + - AO + - AP + - APC + - API + - AQ + - AR + - AS + - ASL + - ASP + - AST + - AT + - ATC + - AU + - AV + - AW + - AX + - AY + - AZ + - B1 + - B2 + - B3 + - B4 + - B5 + - B6 + - B7 + - B8 + - B9 + - BA + - BAA + - BAB + - BAC + - BAD + - BAE + - BAF + - BAG + - BAH + - BAI + - BAJ + - BAK + - BB + - BC + - BCI + - BCN + - BCP + - BD + - BDG + - BDN + - BE + - BEN + - BF + - BG + - BH + - BI + - BJ + - BK + - BKT + - BL + - BLT + - BM + - BMM + - BN + - BO + - BOI + - BP + - BQ + - BR + - BS + - BT + - BU + - BV + - BW + - BX + - BY + - BZ + - C0 + - C1 + - C2 + - C3 + - C4 + - C5 + - C6 + - C7 + - C8 + - C9 + - CA + - CAA + - CAB + - CAC + - CAD + - CAE + - CAF + - CAG + - CAH + - CAI + - CAJ + - CAK + - CAL + - CAM + - CAT + - CB + - CBG + - CC + - CD + - CDN + - CDT + - CE + - CF + - CFR + - CG + - CH + - CHR + - CI + - CID + - CIR + - CIT + - CJ + - CK + - CL + - CLI + - CM + - CMN + - CMP + - CMT + - CN + - CNA + - CNO + - CNS + - CO + - COL + - COT + - CP + - CPA + - CPD + - CPR + - CPT + - CQ + - CR + - CRN + - CRS + - CS + - CSC + - CSG + - CST + - CT + - CTS + - CU + - CUB + - CV + - CVS + - CW + - CX + - CY + - CYC + - CZ + - D0 + - D1 + - D2 + - D3 + - D4 + - D5 + - D6 + - D7 + - D8 + - D9 + - DA + - DAI + - DAN + - DB + - DC + - DD + - DE + - DF + - DG + - DH + - DHH + - DI + - DIS + - DJ + - DK + - DL + - DM + - DN + - DNR + - DNS + - DO + - DOA + - DOC + - DOE + - DOI + - DOJ + - DOL + - DON + - DOS + - DOT + - DP + - DQ + - DR + - DRN + - DS + - DSC + - DSI + - DST + - DT + - DTS + - DU + - DUN + - DV + - DW + - DX + - DY + - DZ + - E00 + - E01 + - E02 + - E1 + - E2 + - E3 + - E4 + - E5 + - E6 + - E7 + - E8 + - E9 + - EA + - EB + - EC + - ECA + - ECB + - ECC + - ECD + - ECE + - ECF + - ECJ + - ED + - EDA + - EE + - EF + - EG + - EH + - EI + - EII + - EJ + - EK + - EL + - EM + - EMM + - EN + - END + - EO + - EP + - EPA + - EPB + - EPC + - EQ + - ER + - ES + - ESN + - ET + - EU + - EV + - EVI + - EW + - EX + - EXP + - EY + - EZ + - F1 + - F2 + - F3 + - F4 + - F5 + - F6 + - F7 + - F8 + - F9 + - FA + - FAN + - FB + - FC + - FCN + - FD + - FE + - FEN + - FF + - FG + - FH + - FHC + - FHO + - FI + - FJ + - FK + - FL + - FLZ + - FM + - FMG + - FMP + - FN + - FND + - FO + - FP + - FQ + - FR + - FRN + - FS + - FSC + - FSN + - FT + - FTN + - FTP + - FTZ + - FU + - FV + - FW + - FWC + - FX + - FY + - FZ + - G1 + - G2 + - G3 + - G4 + - G5 + - G6 + - G7 + - G8 + - G9 + - GA + - GB + - GC + - GD + - GE + - GF + - GG + - GH + - GI + - GJ + - GK + - GL + - GM + - GN + - GO + - GP + - GQ + - GR + - GS + - GT + - GU + - GV + - GW + - GWS + - GX + - GY + - GZ + - H1 + - H2 + - H3 + - H5 + - H6 + - H7 + - H8 + - H9 + - HA + - HB + - HC + - HD + - HE + - HF + - HG + - HH + - HHT + - HI + - HJ + - HK + - HL + - HM + - HMB + - HN + - HO + - HP + - HPI + - HQ + - HR + - HS + - HT + - HU + - HUD + - HV + - HW + - HX + - HY + - HZ + - I1 + - I2 + - I3 + - I4 + - I5 + - I7 + - I9 + - IA + - IB + - IC + - ICD + - ID + - IE + - IF + - IFC + - IFT + - IG + - IH + - II + - IID + - IJ + - IK + - IL + - IM + - IMP + - IMS + - IN + - IND + - IO + - IP + - IQ + - IR + - IRN + - IRP + - IS + - ISC + - ISN + - ISS + - IT + - ITI + - IU + - IV + - IW + - IX + - IZ + - J0 + - J1 + - J2 + - J3 + - J4 + - J5 + - J6 + - J7 + - J8 + - J9 + - JA + - JB + - JC + - JCS + - JD + - JE + - JF + - JH + - JI + - JK + - JL + - JM + - JN + - JO + - JP + - JQ + - JR + - JS + - JT + - JU + - JV + - JW + - JX + - JY + - JZ + - K0 + - K1 + - K2 + - K3 + - K4 + - K5 + - K6 + - K7 + - K8 + - K9 + - KA + - KAS + - KB + - KC + - KCS + - KD + - KE + - KG + - KH + - KI + - KII + - KJ + - KK + - KL + - KM + - KN + - KO + - KP + - KQ + - KR + - KRL + - KRP + - KS + - KSR + - KT + - KU + - KV + - KW + - KX + - KY + - KZ + - L0 + - L1 + - L2 + - L3 + - L4 + - L5 + - L6 + - L7 + - L8 + - L9 + - LA + - LAA + - LAN + - LB + - LC + - LD + - LE + - LEN + - LF + - LG + - LH + - LI + - LIC + - LJ + - LK + - LL + - LM + - LMI + - LN + - LO + - LOI + - LOS + - LP + - LPK + - LQ + - LR + - LS + - LSD + - LT + - LU + - LV + - LVO + - LW + - LX + - LY + - LZ + - M0 + - M1 + - M2 + - M3 + - M5 + - M6 + - M7 + - M8 + - M9 + - MA + - MB + - MBS + - MBX + - MC + - MCC + - MCI + - MCN + - MD + - MDN + - ME + - MF + - MG + - MH + - MI + - MII + - MIN + - MJ + - MK + - ML + - MM + - MN + - MO + - MP + - MPN + - MQ + - MR + - MRC + - MRN + - MS + - MSL + - MT + - MU + - MUI + - MV + - MW + - MX + - MY + - MZ + - MZO + - N0 + - N1 + - N2 + - N3 + - N4 + - N5 + - N6 + - N7 + - N8 + - N9 + - NA + - NAS + - NB + - NC + - ND + - NDA + - NDB + - NE + - NF + - NFC + - NFD + - NFM + - NFN + - NFS + - NG + - NH + - NI + - NJ + - NK + - NL + - NM + - NMT + - NN + - "NO" + - NP + - NQ + - NR + - NS + - NT + - NTP + - NU + - NW + - NX + - NY + - NZ + - O1 + - O2 + - O5 + - O7 + - O8 + - O9 + - OA + - OB + - OC + - OD + - OE + - OF + - "OFF" + - OG + - OH + - OI + - OIC + - OJ + - OK + - OL + - OM + - "ON" + - OOS + - OP + - OPE + - OPF + - OQ + - OR + - OS + - OT + - OU + - OV + - OW + - OX + - OZ + - P1 + - P2 + - P3 + - P4 + - P5 + - P6 + - P7 + - P8 + - P9 + - PA + - PAC + - PAN + - PAP + - PB + - PC + - PCC + - PCN + - PD + - PDI + - PDL + - PDR + - PE + - PF + - PG + - PGC + - PGD + - PGN + - PGS + - PH + - PHC + - PHY + - PI + - PID + - PIN + - PJ + - PJC + - PK + - PKG + - PKU + - PL + - PLA + - PLN + - PM + - PMN + - PN + - PNN + - PO + - POL + - POS + - PP + - PPJ + - PPK + - PPL + - PPM + - PPN + - PQ + - PR + - PRS + - PRT + - PS + - PSI + - PSL + - PSM + - PSN + - PT + - PTC + - PU + - PUA + - PV + - PVC + - PW + - PWC + - PWS + - PX + - PXC + - PY + - PYA + - PYR + - PZ + - Q1 + - Q2 + - Q3 + - Q4 + - Q5 + - Q6 + - Q7 + - Q8 + - Q9 + - QA + - QB + - QC + - QD + - QE + - QF + - QG + - QH + - QI + - QJ + - QK + - QL + - QM + - QN + - QO + - QP + - QQ + - QR + - QS + - QT + - QU + - QV + - QW + - QX + - QY + - QZ + - R0 + - R1 + - R2 + - R3 + - R4 + - R5 + - R6 + - R7 + - R8 + - R9 + - RA + - RAA + - RAN + - RB + - RC + - RD + - RE + - REC + - RF + - RG + - RGI + - RH + - RI + - RIG + - RJ + - RK + - RL + - RLI + - RM + - RN + - RO + - RP + - RPP + - RPS + - RPT + - RQ + - RR + - RRC + - RRS + - RS + - RSN + - RSS + - RT + - RU + - RV + - RW + - RWK + - RX + - RY + - RZ + - S0 + - S1 + - S2 + - S3 + - S4 + - S5 + - S6 + - S7 + - S8 + - S9 + - SA + - SAL + - SB + - SBN + - SC + - SCA + - SCN + - SD + - SDT + - SE + - SEK + - SES + - SF + - SG + - SH + - SHL + - SI + - SII + - SJ + - SK + - SL + - SM + - SMC + - SMT + - SN + - SNH + - SNP + - SNV + - SO + - SP + - SPL + - SPN + - SQ + - SR + - SS + - SST + - ST + - STB + - STR + - STS + - SU + - SUB + - SUC + - SUO + - SV + - SW + - SX + - SY + - SZ + - T0 + - T1 + - T2 + - T3 + - T4 + - T5 + - T6 + - T7 + - T8 + - T9 + - TA + - TB + - TC + - TD + - TDT + - TE + - TF + - TFC + - TG + - TH + - TI + - TIP + - TJ + - TK + - TL + - TM + - TN + - TO + - TOC + - TP + - TPN + - TQ + - TR + - TS + - TSN + - TT + - TU + - TV + - TW + - TX + - TY + - TZ + - U0 + - U1 + - U2 + - U3 + - U4 + - U5 + - U6 + - U8 + - U9 + - UA + - UB + - UC + - UCB + - UCM + - UD + - UE + - UF + - UG + - UH + - UI + - UIC + - UJ + - UK + - UL + - UM + - UN + - UO + - UP + - UQ + - UR + - URL + - URP + - URQ + - US + - UT + - UU + - UV + - UW + - UX + - UY + - UZ + - V0 + - V1 + - V2 + - V3 + - V4 + - V5 + - V6 + - V7 + - V8 + - V9 + - VA + - VAO + - VB + - VC + - VD + - VE + - VF + - VG + - VGS + - VH + - VI + - VJ + - VK + - VL + - VM + - VN + - VO + - VP + - VQ + - VR + - VS + - VT + - VU + - VV + - VW + - VX + - VY + - VZ + - W1 + - W2 + - W3 + - W4 + - W5 + - W6 + - W7 + - W8 + - W9 + - WA + - WB + - WC + - WCS + - WD + - WDR + - WE + - WF + - WG + - WH + - WI + - WJ + - WK + - WL + - WM + - WN + - WO + - WP + - WQ + - WR + - WS + - WT + - WU + - WV + - WW + - WX + - WY + - WZ + - X0 + - X1 + - X2 + - X3 + - X4 + - X5 + - X6 + - X7 + - X8 + - X9 + - XA + - XB + - XC + - XD + - XE + - XF + - XG + - XH + - XI + - XJ + - XK + - XL + - XM + - XN + - XO + - XP + - XQ + - XR + - XS + - XT + - XU + - XV + - XW + - XX + - XX1 + - XX2 + - XX3 + - XX4 + - XX5 + - XX6 + - XX7 + - XX8 + - XY + - XZ + - Y0 + - Y1 + - Y2 + - Y3 + - Y4 + - Y5 + - Y6 + - Y8 + - Y9 + - YA + - YB + - YC + - YD + - YE + - YF + - YH + - YI + - YJ + - YK + - YL + - YM + - YN + - YO + - YP + - YQ + - YR + - YS + - YT + - YV + - YW + - YX + - YY + - YZ + - Z1 + - Z2 + - Z3 + - Z4 + - Z5 + - Z6 + - Z7 + - Z8 + - Z9 + - ZA + - ZB + - ZC + - ZD + - ZE + - ZG + - ZH + - ZI + - ZJ + - ZK + - ZL + - ZM + - ZN + - ZO + - ZP + - ZQ + - ZR + - ZS + - ZT + - ZTS + - ZU + - ZV + - ZW + - ZX + - ZY + - ZZ + C040_ReferenceIdentifier: + required: + - ReferenceIdentificationQualifier_01 + - ReferenceIdentification_02 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_20' + x-freighttrust-element-id: "128" + ReferenceIdentification_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + ReferenceIdentificationQualifier_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_20' + x-freighttrust-element-id: "128" + ReferenceIdentification_04: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + ReferenceIdentificationQualifier_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_20' + x-freighttrust-element-id: "128" + ReferenceIdentification_06: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + x-freighttrust-syntax: + - P0304 + - P0506 + x-freighttrust-composite-id: C040 + REF_BillingProviderTaxIdentification: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_21' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_50: + type: string + enum: + - 0B + - 1G + REF_BillingProviderUPIN: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_50' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + All_REF_837P_8: + required: + - REF_BillingProviderTaxIdentification + type: object + properties: + REF_BillingProviderTaxIdentification: + $ref: '#/components/schemas/REF_BillingProviderTaxIdentification' + REF_BillingProviderUPIN_LicenseInformation: + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/REF_BillingProviderUPIN' + Loop_2010AA_837P: + required: + - AllREF + - N3_BillingProviderAddress + - N4_BillingProviderCity_State_ZIPCode + - NM1_BillingProviderName + type: object + properties: + NM1_BillingProviderName: + $ref: '#/components/schemas/NM1_BillingProviderName_2' + N3_BillingProviderAddress: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_BillingProviderCity_State_ZIPCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + AllREF: + $ref: '#/components/schemas/All_REF_837P_8' + PER_BillingProviderContactInformation: + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/PER_BillingProviderContactInformation' + x-freighttrust-loop-id: 2010AA + X12_ID_98_36: + type: string + enum: + - "87" + X12_ID_66_12: + type: string + enum: + - "0" + - "1" + - "10" + - "11" + - "12" + - "13" + - "15" + - "16" + - "17" + - "19" + - "2" + - "20" + - "21" + - "22" + - "23" + - "24" + - "25" + - "26" + - "27" + - "28" + - "29" + - "3" + - "30" + - "31" + - "32" + - "33" + - "34" + - "35" + - "36" + - "37" + - "38" + - "39" + - "4" + - "40" + - "41" + - "42" + - "43" + - "44" + - "45" + - "46" + - "47" + - "48" + - "49" + - "50" + - "51" + - "53" + - "54" + - "55" + - "56" + - "57" + - "58" + - "59" + - "6" + - "61" + - "62" + - "63" + - "64" + - "7" + - "71" + - "72" + - "73" + - "74" + - "75" + - "76" + - "77" + - "78" + - "81" + - "82" + - "83" + - "9" + - "90" + - "91" + - "92" + - "93" + - "94" + - "95" + - "96" + - "97" + - "98" + - "99" + - A + - A1 + - A2 + - A3 + - A4 + - A5 + - A6 + - A7 + - AA + - AB + - AC + - AD + - AE + - AF + - AI + - AL + - AP + - BC + - BD + - BE + - BG + - BN + - BP + - BS + - C + - C1 + - C2 + - C5 + - CA + - CB + - CC + - CD + - CE + - CF + - CI + - CL + - CM + - CN + - CP + - CR + - CS + - CT + - D + - DG + - DL + - DN + - DO + - DP + - DR + - DS + - E + - EC + - EH + - EI + - EL + - EP + - EQ + - ER + - ES + - ET + - F + - FA + - FB + - FC + - FD + - FE + - FI + - FJ + - FL + - FN + - G + - GA + - GC + - HC + - HN + - HS + - I + - ID + - II + - IP + - J + - K + - L + - LC + - LD + - LE + - LI + - LN + - M + - M3 + - M4 + - M5 + - M6 + - MA + - MB + - MC + - MD + - MI + - MK + - ML + - MN + - MO + - MP + - MR + - "N" + - NA + - ND + - NI + - "NO" + - NR + - OC + - OP + - PA + - PB + - PC + - PI + - PP + - PR + - RA + - RB + - RC + - RD + - RE + - RI + - RP + - RT + - S + - SA + - SB + - SD + - SF + - SI + - SJ + - SK + - SL + - SP + - ST + - SV + - SW + - TA + - TC + - TL + - TS + - TZ + - UC + - UI + - UL + - UP + - UR + - US + - UT + - WR + - WS + - X1 + - XV + - XX + - XY + - ZC + - ZN + - ZY + - ZZ + NM1_Pay: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_36' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_2' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_12' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + Loop_2010AB_837P: + required: + - N3_Pay_ToAddress_ADDRESS + - N4_Pay_AddressCity_State_ZIPCode + - NM1_Pay_AddressName + type: object + properties: + NM1_Pay_AddressName: + $ref: '#/components/schemas/NM1_Pay' + N3_Pay_ToAddress_ADDRESS: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_Pay_AddressCity_State_ZIPCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + x-freighttrust-loop-id: 2010AB + X12_ID_98_23: + type: string + enum: + - PE + X12_ID_66_20: + type: string + enum: + - PI + - XV + NM1_Pay_3: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + - IdentificationCodeQualifier_08 + - ResponseContactIdentifier_09 + - ResponseContactLastorOrganizationName_03 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_23' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_3' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_20' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + X12_ID_128_51: + type: string + enum: + - 2U + - FY + - NF + REF_Pay: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_51' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_22: + type: string + enum: + - EI + REF_BillingProviderTaxIdentification_2: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_22' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + All_REF_837P_3: + required: + - REF_Pay_ToPlanTaxIdentificationNumber + type: object + properties: + REF_Pay_ToPlanSecondaryIdentification: + $ref: '#/components/schemas/REF_Pay' + REF_Pay_ToPlanTaxIdentificationNumber: + $ref: '#/components/schemas/REF_BillingProviderTaxIdentification_2' + Loop_2010AC_837P: + required: + - AllREF + - N3_Pay_ToPlanAddress + - N4_Pay_ToPlanCity_State_ZIPCode + - NM1_Pay_ToPlanName + type: object + properties: + NM1_Pay_ToPlanName: + $ref: '#/components/schemas/NM1_Pay_3' + N3_Pay_ToPlanAddress: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_Pay_ToPlanCity_State_ZIPCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + AllREF: + $ref: '#/components/schemas/All_REF_837P_3' + x-freighttrust-loop-id: 2010AC + All_NM1_837P: + required: + - Loop2010AA + type: object + properties: + Loop2010AA: + $ref: '#/components/schemas/Loop_2010AA_837P' + Loop2010AB: + $ref: '#/components/schemas/Loop_2010AB_837P' + Loop2010AC: + $ref: '#/components/schemas/Loop_2010AC_837P' + X12_ID_735_2: + type: string + enum: + - "22" + X12_ID_736: + type: string + enum: + - "0" + - "1" + HL_SubscriberHierarchicalLevel: + required: + - HierarchicalChildCode_04 + - HierarchicalIDNumber_01 + - HierarchicalLevelCode_03 + - HierarchicalParentIDNumber_02 + type: object + properties: + HierarchicalIDNumber_01: + maxLength: 12 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "628" + HierarchicalParentIDNumber_02: + maxLength: 12 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "734" + HierarchicalLevelCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_735_2' + x-freighttrust-element-id: "735" + HierarchicalChildCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_736' + x-freighttrust-element-id: "736" + x-freighttrust-segment-id: HL + X12_ID_1138_2: + type: string + enum: + - A + - B + - C + - D + - E + - F + - G + - H + - P + - S + - T + - U + X12_ID_1069_6: + type: string + enum: + - "18" + X12_ID_1336_3: + type: string + enum: + - "12" + - "13" + - "14" + - "15" + - "16" + - "41" + - "42" + - "43" + - "47" + X12_ID_1143_2: + type: string + enum: + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + X12_ID_584_2: + type: string + enum: + - "00" + - AA + - AB + - AC + - AD + - AE + - AF + - AG + - AH + - AI + - AJ + - AO + - AP + - AQ + - AS + - AT + - AU + - CA + - CC + - CO + - CT + - DC + - DD + - DI + - DQ + - DR + - DS + - EO + - FA + - FB + - FC + - FO + - FT + - HD + - IA + - IR + - L1 + - L2 + - L3 + - L4 + - L5 + - L6 + - L7 + - LA + - LE + - LF + - LM + - LO + - LS + - LU + - LW + - LX + - NE + - OS + - OT + - PA + - PC + - PE + - PM + - PN + - PR + - PT + - PV + - PW + - RA + - RB + - RC + - RD + - RE + - RI + - RM + - RP + - RR + - RT + - RU + - RW + - SA + - SB + - SE + - SL + - SU + - TE + - TF + - TM + - TN + - TP + - TR + - UK + - VO + - XD + - ZZ + X12_ID_1032_3: + type: string + enum: + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - AM + - BL + - CH + - CI + - DS + - FI + - HM + - LM + - MA + - MB + - MC + - OF + - TV + - VA + - WC + - ZZ + SBR_SubscriberInformation: + required: + - PayerResponsibilitySequenceNumberCode_01 + type: object + properties: + PayerResponsibilitySequenceNumberCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1138_2' + x-freighttrust-element-id: "1138" + IndividualRelationshipCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1069_6' + x-freighttrust-element-id: "1069" + InsuredGrouporPolicyNumber_03: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + OtherInsuredGroupName_04: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "93" + InsuranceTypeCode_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1336_3' + x-freighttrust-element-id: "1336" + CoordinationofBenefitsCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1143_2' + x-freighttrust-element-id: "1143" + YesNoConditionorResponseCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_2' + x-freighttrust-element-id: "1073" + EmploymentStatusCode_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_584_2' + x-freighttrust-element-id: "584" + ClaimFilingIndicatorCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1032_3' + x-freighttrust-element-id: "1032" + x-freighttrust-segment-id: SBR + X12_ID_1069_5: + type: string + enum: + - "01" + - "02" + - "03" + - "04" + - "05" + - "06" + - "07" + - "08" + - "09" + - "10" + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - "18" + - "19" + - "20" + - "21" + - "22" + - "23" + - "24" + - "25" + - "26" + - "27" + - "28" + - "29" + - "30" + - "31" + - "32" + - "33" + - "34" + - "36" + - "37" + - "38" + - "39" + - "40" + - "41" + - "43" + - "45" + - "46" + - "47" + - "48" + - "49" + - "50" + - "51" + - "52" + - "53" + - "55" + - "56" + - "57" + - "58" + - "59" + - "60" + - "61" + - "62" + - "63" + - "64" + - "65" + - "66" + - "67" + - "68" + - "70" + - "71" + - "72" + - "73" + - "74" + - "75" + - "76" + - "78" + - "79" + - "80" + - "81" + - "82" + - "83" + - "84" + - "86" + - "87" + - "88" + - "90" + - "91" + - "92" + - "93" + - "94" + - "95" + - "96" + - "97" + - "98" + - "99" + - A1 + - A2 + - A3 + - A4 + - A5 + - A6 + - A7 + - A8 + - A9 + - B1 + - B2 + - B3 + - B4 + - B5 + - B6 + - B7 + - B8 + - B9 + - C1 + - C2 + - C3 + - C4 + - C5 + - C8 + - C9 + - D1 + - D2 + - D3 + - D4 + - D5 + - D6 + - D7 + - D8 + - D9 + - E1 + - E2 + - E3 + - E4 + - E5 + - E6 + - E7 + - E8 + - E9 + - F1 + - F2 + - F3 + - F6 + - F7 + - F8 + - F9 + - G2 + - G3 + - G4 + - G5 + - G6 + - G7 + - G8 + - G9 + - H1 + - H4 + - N1 + - OT + - ZZ + X12_ID_1384: + type: string + enum: + - A + - B + - C + - D + - E + - F + - G + - H + - L + - M + - O + - P + - R + - S + - T + X12_ID_1220: + type: string + enum: + - F + - "N" + - P + X12_ID_1250_6: + type: string + enum: + - D8 + X12_ID_355_16: + type: string + enum: + - "01" + X12_ID_1073: + type: string + enum: + - "Y" + PAT_PatientInformation_3: + type: object + properties: + IndividualRelationshipCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1069_5' + x-freighttrust-element-id: "1069" + PatientLocationCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1384' + x-freighttrust-element-id: "1384" + EmploymentStatusCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_584_2' + x-freighttrust-element-id: "584" + StudentStatusCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1220' + x-freighttrust-element-id: "1220" + DateTimePeriodFormatQualifier_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + PatientDeathDate_06: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + UnitorBasisforMeasurementCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355_16' + x-freighttrust-element-id: "355" + PatientWeight_08: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "81" + PregnancyIndicator_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073' + x-freighttrust-element-id: "1073" + x-freighttrust-syntax: + - P0506 + - P0708 + x-freighttrust-segment-id: PAT + X12_ID_98_26: + type: string + enum: + - IL + X12_ID_66_8: + type: string + enum: + - II + - MI + NM1_SubscriberName_5: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + - ResponseContactLastorOrganizationName_03 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_26' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_2' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_8' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + X12_ID_1068_2: + type: string + enum: + - F + - M + - U + X12_ID_1067: + type: string + enum: + - A + - B + - C + - D + - I + - K + - M + - R + - S + - U + - W + - X + X12_ID_1109: + type: string + enum: + - "7" + - "8" + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - "N" + - O + - P + - Q + - R + - S + - T + - U + - V + - W + - Z + X12_ID_1270_28: + type: string + enum: + - "0" + - "1" + - "10" + - "100" + - "101" + - "102" + - "103" + - "104" + - "105" + - "106" + - "107" + - "108" + - "109" + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - "18" + - "19" + - "20" + - "21" + - "22" + - "23" + - "24" + - "25" + - "26" + - "27" + - "28" + - "29" + - "3" + - "30" + - "31" + - "32" + - "33" + - "34" + - "35" + - "36" + - "37" + - "38" + - "39" + - "4" + - "40" + - "41" + - "42" + - "43" + - "44" + - "45" + - "46" + - "47" + - "48" + - "49" + - "5" + - "50" + - "52" + - "53" + - "54" + - "55" + - "56" + - "57" + - "58" + - "59" + - "60" + - "61" + - "62" + - "63" + - "65" + - "66" + - "67" + - "68" + - "69" + - "7" + - "71" + - "72" + - "73" + - "74" + - "75" + - "78" + - "79" + - "8" + - "80" + - "81" + - "82" + - "83" + - "84" + - "85" + - "87" + - "88" + - "89" + - "90" + - "91" + - "92" + - "93" + - "94" + - "95" + - "96" + - "97" + - "98" + - "99" + - A + - A1 + - A2 + - A3 + - A4 + - A5 + - A6 + - A7 + - A8 + - A9 + - AA + - AAA + - AAD + - AAE + - AAF + - AAG + - AAH + - AAI + - AAJ + - AAK + - AAL + - AAM + - AAN + - AAO + - AAP + - AAQ + - AAR + - AAS + - AAT + - AAU + - AAV + - AAW + - AAX + - AAY + - AB + - ABF + - ABJ + - ABK + - ABN + - ABR + - ABS + - ABU + - ABV + - AC + - ACR + - AD + - ADD + - ADJ + - AE + - AF + - AG + - AH + - AI + - AJ + - AJT + - AK + - AL + - ALM + - ALP + - AM + - AN + - AO + - APE + - APR + - AQ + - AR + - ARI + - AS + - ASD + - AT + - ATD + - ATT + - AU + - AV + - AW + - AX + - AY + - AZ + - B + - BA + - BB + - BBQ + - BBR + - BC + - BCC + - BCR + - BD + - BE + - BF + - BG + - BH + - BI + - BJ + - BK + - BL + - BN + - BO + - BP + - BPL + - BQ + - BR + - BRL + - BS + - BSL + - BSP + - BT + - BTC + - BU + - BUI + - BV + - BW + - BX + - BY + - BZ + - C + - C1 + - C2 + - C3 + - CA + - CAH + - CB + - CC + - CD + - CE + - CF + - CFI + - CG + - CH + - CHG + - CI + - CIE + - CJ + - CK + - CL + - CLP + - CM + - CML + - CN + - CNC + - CO + - COG + - CP + - CPS + - CQ + - CR + - CRC + - CS + - CSD + - CSF + - CT + - CU + - CV + - CW + - CZ + - D + - D1 + - D2 + - D3 + - D4 + - D5 + - DA + - DAC + - DB + - DBS + - DC + - DD + - DE + - DF + - DG + - DGO + - DH + - DI + - DJ + - DK + - DL + - DLO + - DLP + - DM + - DN + - DO + - DOF + - DP + - DPE + - DPL + - DQ + - DR + - DRL + - DS + - DSR + - DSS + - DT + - DU + - DW + - DX + - DY + - DZ + - E + - EA + - EAA + - EAB + - EAC + - EAD + - EAE + - EAF + - EAG + - EAH + - EAI + - EAJ + - EAK + - EAL + - EAM + - EAN + - EAO + - EAP + - EAQ + - EAR + - EAS + - EAT + - EAU + - EAV + - EAW + - EAX + - EAY + - EAZ + - EB + - EBA + - EBB + - EBC + - EBD + - EBE + - EBF + - EBG + - EBH + - EBI + - EBJ + - EBK + - EBL + - EBM + - EBN + - EBO + - EBP + - EBQ + - EBR + - EBS + - EBT + - EBU + - EBV + - EBW + - EBX + - EBY + - EBZ + - EC + - ECA + - ECB + - ECC + - ECD + - ECE + - ECF + - ECG + - ECH + - ECI + - ECJ + - ECK + - ECL + - ECM + - ECN + - ECO + - ECP + - ECQ + - ECR + - ECS + - ECT + - ECU + - ECV + - ECW + - ECX + - ECY + - ECZ + - ED + - EDA + - EDB + - EDC + - EDD + - EDE + - EDF + - EDG + - EDH + - EDI + - EDJ + - EDK + - EDL + - EDM + - EDN + - EDO + - EDP + - EDQ + - EDR + - EDS + - EDT + - EDU + - EDV + - EDW + - EDX + - EDY + - EDZ + - EE + - EEA + - EEB + - EEC + - EED + - EEE + - EEF + - EEG + - EEH + - EEI + - EEJ + - EEK + - EEL + - EEM + - EEN + - EEO + - EEP + - EEQ + - EER + - EES + - EF + - EG + - EH + - EI + - EJ + - EK + - EL + - EM + - EMC + - EN + - EO + - EQ + - EQR + - ER + - ES + - ESC + - ESL + - ET + - ETL + - EU + - EV + - EW + - EWC + - EWR + - EX + - EXD + - EY + - EZ + - F + - FA + - FAP + - FB + - FC + - FC1 + - FD + - FE + - FF + - FF1 + - FG + - FH + - FH1 + - FI + - FIR + - FJ + - FK + - FL + - FL1 + - FM + - FMO + - FMS + - FN + - FO + - FP + - FP1 + - FQ + - FR + - FRP + - FS + - FT + - FT1 + - FU + - FV + - FW + - FX + - FZ + - G + - G1 + - GA + - GB + - GC + - GD + - GE + - GF + - GG + - GI + - GJ + - GK + - GQ + - GR + - GS + - GT + - GU + - GV + - GW + - GX + - GY + - GZ + - H + - HA + - HB + - HC + - HD + - HE + - HF + - HG + - HI + - HJ + - HK + - HL + - HM + - HO + - HRC + - HS + - HZR + - I + - IBP + - IC + - ID + - IF + - IMC + - IMP + - IND + - IPA + - IQ + - IRR + - IRT + - IT + - J + - J0 + - J1 + - J2 + - J3 + - J4 + - J5 + - J6 + - J7 + - J8 + - J9 + - JA + - JB + - JC + - JCL + - JD + - JE + - JF + - JG + - JH + - JI + - JK + - JL + - JM + - JN + - JO + - JOL + - JP + - K + - KA + - KB + - KC + - KD + - KE + - KF + - KG + - KH + - KI + - KJ + - KK + - KL + - KM + - KO + - KP + - KQ + - KS + - KT + - KU + - KW + - KYL + - KZ + - L + - LA + - LB + - LC + - LD + - LE + - LF + - LG + - LH + - LIN + - LJ + - LK + - LM + - LN + - LO + - LOC + - LOI + - LP + - LQ + - LR + - LS + - LSC + - LT + - LZ + - M + - MA + - MAC + - MB + - MC + - MCC + - MCD + - ME + - MEC + - MI + - MJ + - MK + - ML + - MN + - MOC + - MOE + - MRI + - MS + - MT + - "N" + - NA + - NAC + - NAF + - NAN + - NAS + - NB + - NC + - ND + - NDC + - NE + - NF + - NH + - NI + - NIR + - NJ + - NK + - NP + - NPC + - NR + - NS + - NT + - NUB + - O + - O1 + - O2 + - O3 + - O4 + - OC + - P + - PA + - PB + - PC + - PCR + - PD + - PDA + - PGS + - PHC + - PI + - PIT + - PL + - PLC + - PLS + - POB + - PPD + - PPP + - PPS + - PPV + - PQA + - PR + - PRA + - PRC + - PRI + - PRR + - PRT + - PS + - PT + - PWA + - PWI + - PWR + - PWS + - PWT + - Q + - QA + - QB + - QC + - QDR + - QE + - QF + - QG + - QH + - QI + - QJ + - QK + - QS + - QT + - R + - R1 + - R2 + - R3 + - R4 + - RA + - RAS + - RC + - RCA + - RD + - RE + - REC + - RED + - REN + - RET + - RFC + - RI + - RJC + - RQ + - RSS + - RT + - RTC + - RUM + - RVC + - RX + - S + - SA + - SAT + - SB + - SBA + - SC + - SCI + - SD + - SE + - SEC + - SET + - SF + - SG + - SH + - SHL + - SHM + - SHN + - SHO + - SHP + - SHQ + - SHR + - SHS + - SHT + - SHU + - SHV + - SHW + - SHX + - SHY + - SHZ + - SI + - SIA + - SIB + - SIC + - SID + - SIE + - SIF + - SIG + - SIH + - SII + - SIJ + - SIK + - SIL + - SIM + - SIN + - SIO + - SIP + - SIQ + - SIR + - SIS + - SIT + - SIU + - SIV + - SIW + - SIX + - SIY + - SIZ + - SJ + - SJA + - SJB + - SJC + - SJD + - SJE + - SJF + - SJG + - SJH + - SJI + - SJJ + - SJK + - SJL + - SJM + - SJN + - SJO + - SJP + - SJQ + - SJR + - SJS + - SJT + - SJU + - SJV + - SJW + - SJX + - SJY + - SJZ + - SKA + - SKB + - SKC + - SKD + - SKE + - SKF + - SKG + - SKH + - SKI + - SKJ + - SKK + - SKL + - SKM + - SKN + - SKO + - SKP + - SKQ + - SKR + - SKS + - SKT + - SKU + - SKV + - SKW + - SKX + - SKY + - SKZ + - SL + - SLA + - SLS + - SMB + - SMC + - SMD + - SMI + - SMT + - SO + - SP + - SPE + - SR + - SRL + - SRR + - SRT + - SS + - SSC + - ST + - STC + - STF + - SUI + - SVC + - SWR + - T + - T00 + - T01 + - T02 + - T03 + - T04 + - T05 + - T06 + - T07 + - T08 + - T09 + - T10 + - T11 + - T12 + - T13 + - T14 + - T15 + - T16 + - T17 + - T18 + - T19 + - T20 + - T21 + - T22 + - T23 + - T24 + - T25 + - T26 + - T27 + - T28 + - T29 + - T30 + - T31 + - T32 + - T33 + - T34 + - T35 + - TB + - TC + - TCD + - TCL + - TD + - TE + - TF + - TFR + - TG + - TL + - TOL + - TP + - TQ + - TR + - TT + - TTL + - TX + - TY + - U + - UER + - UJC + - UNP + - UPC + - UPT + - UR + - US + - UT + - UTC + - UU + - V + - VAL + - VP + - W + - WDL + - WRC + - WSD + - X + - XD + - "Y" + - Z + - ZZ + C056_CompositeRaceOrEthnicityInformation: + type: object + properties: + RaceorEthnicityCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1109' + x-freighttrust-element-id: "1109" + CodeListQualifierCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1270_28' + x-freighttrust-element-id: "1270" + IndustryCode_03: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + x-freighttrust-syntax: + - P0203 + x-freighttrust-composite-id: C056 + X12_ID_1066: + type: string + enum: + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + - A + - B + - C + - D + - E + - F + - G + - H + - I + X12_ID_659: + type: string + enum: + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + - A + - B + - C + - D + - E + - F + - G + - H + - I + - J + - K + DMG_PatientDemographicInformation: + required: + - DateTimePeriodFormatQualifier_01 + - DependentBirthDate_02 + - DependentGenderCode_03 + type: object + properties: + DateTimePeriodFormatQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DependentBirthDate_02: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + DependentGenderCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1068_2' + x-freighttrust-element-id: "1068" + MaritalStatusCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1067' + x-freighttrust-element-id: "1067" + CompositeRaceOrEthnicityInformation_05: + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/C056_CompositeRaceOrEthnicityInformation' + CitizenshipStatusCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1066' + x-freighttrust-element-id: "1066" + CountryCode_07: + maxLength: 3 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "26" + BasisofVerificationCode_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_659' + x-freighttrust-element-id: "659" + Quantity_09: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + CodeListQualifierCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1270_28' + x-freighttrust-element-id: "1270" + IndustryCode_11: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + x-freighttrust-syntax: + - P0102 + - P1011 + - C1105 + x-freighttrust-segment-id: DMG + X12_ID_128_60: + type: string + enum: + - SY + REF_OtherSubscriberSecondaryIdentification: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_60' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_69: + type: string + enum: + - Y4 + REF_PropertyandCasualtyClaimNumber: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_69' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + All_REF_837P_4: + type: object + properties: + REF_SubscriberSecondaryIdentification: + $ref: '#/components/schemas/REF_OtherSubscriberSecondaryIdentification' + REF_PropertyandCasualtyClaimNumber: + $ref: '#/components/schemas/REF_PropertyandCasualtyClaimNumber' + X12_ID_365_8: + type: string + enum: + - TE + X12_ID_365_7: + type: string + enum: + - EX + X12_ID_365_12: + type: string + enum: + - AA + - AB + - AC + - AD + - AE + - AP + - AS + - AU + - BN + - BT + - CA + - CP + - DN + - EA + - ED + - EM + - EX + - FT + - FU + - FX + - HF + - HP + - IT + - MN + - NP + - OF + - OT + - PA + - PC + - PP + - PS + - SP + - TE + - TL + - TM + - TN + - TX + - UR + - VM + - WC + - WF + - WP + PER_PropertyandCasualtyPatientContactInformation: + required: + - CommunicationNumberQualifier_03 + - ContactFunctionCode_01 + - ResponseContactCommunicationNumber_04 + type: object + properties: + ContactFunctionCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_366_4' + x-freighttrust-element-id: "366" + ResponseContactName_02: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "93" + CommunicationNumberQualifier_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_365_8' + x-freighttrust-element-id: "365" + ResponseContactCommunicationNumber_04: + maxLength: 256 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "364" + CommunicationNumberQualifier_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_365_7' + x-freighttrust-element-id: "365" + ResponseContactCommunicationNumber_06: + maxLength: 256 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "364" + CommunicationNumberQualifier_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_365_12' + x-freighttrust-element-id: "365" + ResponseContactCommunicationNumber_08: + maxLength: 256 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "364" + ContactInquiryReference_09: + maxLength: 20 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "443" + x-freighttrust-syntax: + - P0304 + - P0506 + - P0708 + x-freighttrust-segment-id: PER + Loop_2010BA_837P: + required: + - NM1_SubscriberName + type: object + properties: + NM1_SubscriberName: + $ref: '#/components/schemas/NM1_SubscriberName_5' + N3_SubscriberAddress: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_SubscriberCity_State_ZIPCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + DMG_SubscriberDemographicInformation: + $ref: '#/components/schemas/DMG_PatientDemographicInformation' + AllREF: + $ref: '#/components/schemas/All_REF_837P_4' + PER_PropertyandCasualtySubscriberContactInformation: + $ref: '#/components/schemas/PER_PropertyandCasualtyPatientContactInformation' + x-freighttrust-loop-id: 2010BA + X12_ID_98_29: + type: string + enum: + - PR + NM1_OtherPayerName: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + - IdentificationCodeQualifier_08 + - ResponseContactIdentifier_09 + - ResponseContactLastorOrganizationName_03 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_29' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_3' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_20' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + X12_ID_128_75: + type: string + enum: + - 2U + - EI + - FY + - NF + REF_OtherPayerSecondaryIdentifier: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_75' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_2: + type: string + enum: + - G2 + - LU + REF_BillingProviderSecondaryIdentification: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_2' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + All_REF_837P_5: + type: object + properties: + REF_PayerSecondaryIdentification: + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/REF_OtherPayerSecondaryIdentifier' + REF_BillingProviderSecondaryIdentification: + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/REF_BillingProviderSecondaryIdentification' + Loop_2010BB_837P: + required: + - NM1_PayerName + type: object + properties: + NM1_PayerName: + $ref: '#/components/schemas/NM1_OtherPayerName' + N3_PayerAddress: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_PayerCity_State_ZIPCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + AllREF: + $ref: '#/components/schemas/All_REF_837P_5' + x-freighttrust-loop-id: 2010BB + All_NM1_837P_2: + required: + - Loop2010BA + - Loop2010BB + type: object + properties: + Loop2010BA: + $ref: '#/components/schemas/Loop_2010BA_837P' + Loop2010BB: + $ref: '#/components/schemas/Loop_2010BB_837P' + X12_ID_1032: + type: string + enum: + - "01" + - "02" + - "03" + - "04" + - "05" + - "06" + - "07" + - "08" + - "09" + - "10" + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - "18" + - "19" + - "20" + - "21" + - "22" + - "31" + - "32" + - "33" + - AM + - BL + - CH + - CI + - CN + - DS + - FI + - HM + - LI + - LM + - MA + - MB + - MC + - MH + - OF + - SA + - TV + - VA + - WB + - WC + - WD + - WE + - ZZ + X12_ID_1343: + type: string + enum: + - A + - AA + - AM + - AN + - CF + - CH + - CS + - DA + - DD + - DM + - DN + - ER + - HH + - HS + - IF + - IL + - L + - LT + - MD + - MF + - MH + - MI + - MO + - MS + - NM + - NP + - NS + - O + - OC + - OP + - OT + - OX + - P + - PA + - PD + - PE + - PF + - PS + - PT + - RX + - S + - SC + - SN + - ST + - T + - TX + - V + X12_ID_1332_2: + type: string + enum: + - B + C023_HealthCareServiceLocationInformation_2: + required: + - ClaimFrequencyTypeCode_03 + - FacilityCodeQualifier_02 + - FacilityTypeCode_01 + type: object + properties: + FacilityTypeCode_01: + maxLength: 2 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1331" + FacilityCodeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1332_2' + x-freighttrust-element-id: "1332" + ClaimFrequencyTypeCode_03: + maxLength: 1 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1325" + x-freighttrust-composite-id: C023 + X12_ID_1073_4: + type: string + enum: + - "N" + - "Y" + X12_ID_1359_2: + type: string + enum: + - A + - B + - C + X12_ID_1073_5: + type: string + enum: + - "N" + - W + - "Y" + X12_ID_1363_2: + type: string + enum: + - I + - "Y" + X12_ID_1351: + type: string + enum: + - P + X12_ID_1362_2: + type: string + enum: + - AA + - EM + - OA + X12_ID_1362: + type: string + enum: + - AA + - AB + - AP + - EM + - OA + - ZZ + C024_RelatedCausesInformation_3: + required: + - RelatedCausesCode_01 + type: object + properties: + RelatedCausesCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1362_2' + x-freighttrust-element-id: "1362" + RelatedCausesCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1362_2' + x-freighttrust-element-id: "1362" + RelatedCausesCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1362' + x-freighttrust-element-id: "1362" + StateorProvinceCode_04: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "156" + CountryCode_05: + maxLength: 3 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "26" + x-freighttrust-composite-id: C024 + X12_ID_1366_3: + type: string + enum: + - "02" + - "03" + - "05" + - "09" + X12_ID_1338: + type: string + enum: + - "00" + - "01" + - "02" + - "03" + - "04" + - "05" + - "06" + - "09" + - "10" + - "11" + - E + - F1 + - F2 + - I + - L + - NBC + - R + - U + X12_ID_1360: + type: string + enum: + - D + - E + - H + - I + - "N" + - P + - "Y" + X12_ID_1029_2: + type: string + enum: + - "1" + - "10" + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - "18" + - "19" + - "2" + - "20" + - "21" + - "22" + - "23" + - "24" + - "25" + - "26" + - "27" + - "28" + - "29" + - "3" + - "30" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + - AD + - AP + - CC + - CL + - CP + - I + - RA + - RB + - RC + - RD + - RO + X12_ID_1383: + type: string + enum: + - "00" + - "01" + - "02" + - "03" + - "05" + - "07" + - "08" + - "09" + - "15" + - "16" + - "17" + - "18" + - "20" + - "22" + - "27" + - "28" + - "29" + - PB + X12_ID_1514_2: + type: string + enum: + - "1" + - "10" + - "11" + - "15" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + - "9" + CLM_ClaimInformation_3: + required: + - AssignmentorPlanParticipationCode_07 + - BenefitsAssignmentCertificationIndicator_08 + - HealthCareServiceLocationInformation_05 + - PatientControlNumber_01 + - ProviderorSupplierSignatureIndicator_06 + - ReleaseofInformationCode_09 + - TotalClaimChargeAmount_02 + type: object + properties: + PatientControlNumber_01: + maxLength: 38 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1028" + TotalClaimChargeAmount_02: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + ClaimFilingIndicatorCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1032' + x-freighttrust-element-id: "1032" + NonInstitutionalClaimTypeCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1343' + x-freighttrust-element-id: "1343" + HealthCareServiceLocationInformation_05: + $ref: '#/components/schemas/C023_HealthCareServiceLocationInformation_2' + ProviderorSupplierSignatureIndicator_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_4' + x-freighttrust-element-id: "1073" + AssignmentorPlanParticipationCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1359_2' + x-freighttrust-element-id: "1359" + BenefitsAssignmentCertificationIndicator_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_5' + x-freighttrust-element-id: "1073" + ReleaseofInformationCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1363_2' + x-freighttrust-element-id: "1363" + PatientSignatureSourceCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1351' + x-freighttrust-element-id: "1351" + RelatedCausesInformation_11: + $ref: '#/components/schemas/C024_RelatedCausesInformation_3' + SpecialProgramIndicator_12: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1366_3' + x-freighttrust-element-id: "1366" + YesNoConditionorResponseCode_13: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_2' + x-freighttrust-element-id: "1073" + LevelofServiceCode_14: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1338' + x-freighttrust-element-id: "1338" + YesNoConditionorResponseCode_15: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_2' + x-freighttrust-element-id: "1073" + ProviderAgreementCode_16: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1360' + x-freighttrust-element-id: "1360" + ClaimStatusCode_17: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1029_2' + x-freighttrust-element-id: "1029" + YesNoConditionorResponseCode_18: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_2' + x-freighttrust-element-id: "1073" + PredeterminationofBenefitsCode_19: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1383' + x-freighttrust-element-id: "1383" + DelayReasonCode_20: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1514_2' + x-freighttrust-element-id: "1514" + x-freighttrust-segment-id: CLM + X12_ID_374_20: + type: string + enum: + - "431" + DTP_OnsetofCurrentIllnessorSymptom: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_20' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_32: + type: string + enum: + - "454" + DTP_InitialTreatmentDate: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_32' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_36: + type: string + enum: + - "304" + DTP_LastSeenDate: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_36' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_40: + type: string + enum: + - "453" + DTP_AcuteManifestation: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_40' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_19: + type: string + enum: + - "439" + DTP_AccidentDate_2: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_19' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_16: + type: string + enum: + - "484" + DTP_LastMenstrualPeriod: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_16' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_46: + type: string + enum: + - "455" + DTP_LastXrayDate: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_46' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_48: + type: string + enum: + - "471" + DTP_HearingandVisionPrescriptionDate: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_48' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_3: + type: string + enum: + - "314" + - "360" + - "361" + X12_ID_1250_2: + type: string + enum: + - D8 + - RD8 + DTP_DisabilityDates: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_3' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_2' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_5: + type: string + enum: + - "297" + DTP_LastWorked: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_5' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_6: + type: string + enum: + - "296" + DTP_AuthorizedReturntoWork: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_6' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_7: + type: string + enum: + - "435" + DTP_AdmissionDate_4: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_7' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_8: + type: string + enum: + - "096" + DTP_Discharge: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_8' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_9: + type: string + enum: + - "090" + - "091" + DTP_AssumedandRelinquishedCareDates: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_9' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_10: + type: string + enum: + - "444" + DTP_PropertyandCasualtyDateofFirstContact: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_10' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_11: + type: string + enum: + - "050" + DTP_RepricerReceivedDate: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_11' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + All_DTP_837P_2: + type: object + properties: + DTP_Date_OnsetofCurrentIllnessorSymptom: + $ref: '#/components/schemas/DTP_OnsetofCurrentIllnessorSymptom' + DTP_Date_InitialTreatmentDate: + $ref: '#/components/schemas/DTP_InitialTreatmentDate' + DTP_Date_LastSeenDate: + $ref: '#/components/schemas/DTP_LastSeenDate' + DTP_Date_AcuteManifestation: + $ref: '#/components/schemas/DTP_AcuteManifestation' + DTP_Date_Accident: + $ref: '#/components/schemas/DTP_AccidentDate_2' + DTP_Date_LastMenstrualPeriod: + $ref: '#/components/schemas/DTP_LastMenstrualPeriod' + DTP_Date_LastX_Date: + $ref: '#/components/schemas/DTP_LastXrayDate' + DTP_Date_HearingandVisionPrescriptionDate: + $ref: '#/components/schemas/DTP_HearingandVisionPrescriptionDate' + DTP_Date_DisabilityDates: + $ref: '#/components/schemas/DTP_DisabilityDates' + DTP_Date_LastWorked: + $ref: '#/components/schemas/DTP_LastWorked' + DTP_Date_AuthorizedReturntoWork: + $ref: '#/components/schemas/DTP_AuthorizedReturntoWork' + DTP_Date_Admission: + $ref: '#/components/schemas/DTP_AdmissionDate_4' + DTP_Date_Discharge: + $ref: '#/components/schemas/DTP_Discharge' + DTP_Date_AssumedandRelinquishedCareDates: + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/DTP_AssumedandRelinquishedCareDates' + DTP_PropertyandCasualtyDateofFirstContact: + $ref: '#/components/schemas/DTP_PropertyandCasualtyDateofFirstContact' + DTP_Date_RepricerReceivedDate: + $ref: '#/components/schemas/DTP_RepricerReceivedDate' + X12_ID_755_5: + type: string + enum: + - "03" + - "04" + - "05" + - "06" + - "07" + - "08" + - "09" + - "10" + - "11" + - "13" + - "15" + - "21" + - "77" + - A3 + - A4 + - AM + - AS + - B2 + - B3 + - B4 + - BR + - BS + - BT + - CB + - CK + - CT + - D2 + - DA + - DB + - DG + - DJ + - DS + - EB + - HC + - HR + - I5 + - IR + - LA + - M1 + - MT + - NN + - OB + - OC + - OD + - OE + - OX + - OZ + - P4 + - P5 + - PE + - PN + - PO + - PQ + - PY + - PZ + - RB + - RR + - RT + - RX + - SG + - V5 + - XP + X12_ID_756_5: + type: string + enum: + - AA + - BM + - EL + - EM + - FT + - FX + X12_ID_66_16: + type: string + enum: + - AC + X12_ID_704: + type: string + enum: + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - CH + - CO + - DM + - NT + - "ON" + - OR + - PV + - SG + C002_ActionsIndicated_2: + required: + - PaperworkReportActionCode_01 + type: object + properties: + PaperworkReportActionCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_704' + x-freighttrust-element-id: "704" + PaperworkReportActionCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_704' + x-freighttrust-element-id: "704" + PaperworkReportActionCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_704' + x-freighttrust-element-id: "704" + PaperworkReportActionCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_704' + x-freighttrust-element-id: "704" + PaperworkReportActionCode_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_704' + x-freighttrust-element-id: "704" + x-freighttrust-composite-id: C002 + X12_ID_1525: + type: string + enum: + - AR + - BA + - HS + - IN + - PR + - RE + - SC + PWK_ClaimSupplementalInformation_3: + required: + - AttachmentReportTypeCode_01 + - ReportTransmissionCode_02 + type: object + properties: + AttachmentReportTypeCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_755_5' + x-freighttrust-element-id: "755" + ReportTransmissionCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_756_5' + x-freighttrust-element-id: "756" + ReportCopiesNeeded_03: + maxLength: 2 + minLength: 1 + type: string + format: X12_N0 + x-freighttrust-element-id: "757" + EntityIdentifierCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + IdentificationCodeQualifier_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_16' + x-freighttrust-element-id: "66" + AttachmentControlNumber_06: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + AttachmentDescription_07: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ActionsIndicated_08: + $ref: '#/components/schemas/C002_ActionsIndicated_2' + RequestCategoryCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1525' + x-freighttrust-element-id: "1525" + x-freighttrust-syntax: + - P0506 + x-freighttrust-segment-id: PWK + X12_ID_1166_2: + type: string + enum: + - "01" + - "02" + - "03" + - "04" + - "05" + - "06" + - "09" + CN1_ContractInformation_2: + required: + - ContractTypeCode_01 + type: object + properties: + ContractTypeCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1166_2' + x-freighttrust-element-id: "1166" + ContractAmount_02: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + ContractPercentage_03: + maxLength: 6 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "332" + ContractCode_04: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + TermsDiscountPercentage_05: + maxLength: 6 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "338" + ContractVersionIdentifier_06: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "799" + x-freighttrust-segment-id: CN1 + X12_ID_522_16: + type: string + enum: + - F5 + X12_ID_478: + type: string + enum: + - C + - D + AMT_PatientAmountPaid: + required: + - AmountQualifierCode_01 + - TotalClaimChargeAmount_02 + type: object + properties: + AmountQualifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_522_16' + x-freighttrust-element-id: "522" + TotalClaimChargeAmount_02: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + CreditDebitFlagCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_478' + x-freighttrust-element-id: "478" + x-freighttrust-segment-id: AMT + X12_ID_128_7: + type: string + enum: + - 4N + X12_ID_127: + type: string + enum: + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + REF_ServiceAuthorizationExceptionCode: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_7' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_127' + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_9: + type: string + enum: + - F5 + X12_ID_127_2: + type: string + enum: + - "N" + - "Y" + REF_MandatoryMedicare: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_9' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_127_2' + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_11: + type: string + enum: + - EW + REF_MammographyCertificationNumber: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_11' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_3: + type: string + enum: + - 9F + REF_OtherPayerReferralNumber: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_3' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_6: + type: string + enum: + - G1 + REF_OtherPayerPriorAuthorizationNumber: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_6' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_8: + type: string + enum: + - F8 + REF_OtherPayerClaimControlNumber: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_8' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_16: + type: string + enum: + - X4 + REF_ClinicalLaboratoryImprovementAmendment: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_16' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_10: + type: string + enum: + - 9A + REF_RepricedClaimNumber: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_10' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_12: + type: string + enum: + - 9C + REF_AdjustedRepricedClaimNumber: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_12' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_13: + type: string + enum: + - LX + REF_InvestigationalDeviceExemptionNumber: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_13' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_14: + type: string + enum: + - D9 + REF_ClaimIdentificationNumberForClearinghousesAndOtherTransmissionIntermediaries: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_14' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_17: + type: string + enum: + - EA + REF_MedicalRecordNumber: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_17' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_19: + type: string + enum: + - P4 + REF_DemonstrationProjectIdentifier: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_19' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_29: + type: string + enum: + - 1J + REF_CarePlanOversight: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_29' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + All_REF_837P_6: + type: object + properties: + REF_ServiceAuthorizationExceptionCode: + $ref: '#/components/schemas/REF_ServiceAuthorizationExceptionCode' + REF_MandatoryMedicare_Section4081_CrossoverIndicator: + $ref: '#/components/schemas/REF_MandatoryMedicare' + REF_MammographyCertificationNumber: + $ref: '#/components/schemas/REF_MammographyCertificationNumber' + REF_ReferralNumber: + $ref: '#/components/schemas/REF_OtherPayerReferralNumber' + REF_PriorAuthorization: + $ref: '#/components/schemas/REF_OtherPayerPriorAuthorizationNumber' + REF_PayerClaimControlNumber: + $ref: '#/components/schemas/REF_OtherPayerClaimControlNumber' + REF_ClinicalLaboratoryImprovementAmendment_CLIA_Number: + $ref: '#/components/schemas/REF_ClinicalLaboratoryImprovementAmendment' + REF_RepricedClaimNumber: + $ref: '#/components/schemas/REF_RepricedClaimNumber' + REF_AdjustedRepricedClaimNumber: + $ref: '#/components/schemas/REF_AdjustedRepricedClaimNumber' + REF_InvestigationalDeviceExemptionNumber: + $ref: '#/components/schemas/REF_InvestigationalDeviceExemptionNumber' + REF_ClaimIdentifierForTransmissionIntermediaries: + $ref: '#/components/schemas/REF_ClaimIdentificationNumberForClearinghousesAndOtherTransmissionIntermediaries' + REF_MedicalRecordNumber: + $ref: '#/components/schemas/REF_MedicalRecordNumber' + REF_DemonstrationProjectIdentifier: + $ref: '#/components/schemas/REF_DemonstrationProjectIdentifier' + REF_CarePlanOversight: + $ref: '#/components/schemas/REF_CarePlanOversight' + X12_ID_1333: + type: string + enum: + - C + - D + - E + - F + - P + - S + X12_ID_355: + type: string + enum: + - "01" + - "02" + - "03" + - "04" + - "05" + - "06" + - "07" + - "08" + - "09" + - "10" + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - "18" + - "19" + - 1A + - 1B + - 1C + - 1D + - 1E + - 1F + - 1G + - 1H + - 1I + - 1J + - 1K + - 1L + - 1M + - 1N + - 1O + - 1P + - 1Q + - 1R + - 1T + - 1X + - "20" + - "21" + - "22" + - "23" + - "24" + - "25" + - "26" + - "27" + - "28" + - "29" + - 2A + - 2B + - 2C + - 2D + - 2F + - 2G + - 2H + - 2I + - 2J + - 2K + - 2L + - 2M + - 2N + - 2P + - 2Q + - 2R + - 2U + - 2V + - 2W + - 2X + - 2Y + - 2Z + - "30" + - "31" + - "32" + - "33" + - "34" + - "35" + - "36" + - "37" + - "38" + - "39" + - 3B + - 3C + - 3E + - 3F + - 3G + - 3H + - 3I + - "40" + - "41" + - "43" + - "44" + - "45" + - "46" + - "47" + - "48" + - 4A + - 4B + - 4C + - 4D + - 4E + - 4F + - 4G + - 4I + - 4J + - 4K + - 4L + - 4M + - 4N + - 4O + - 4P + - 4Q + - 4R + - 4S + - 4T + - 4U + - 4V + - 4W + - 4X + - "50" + - "51" + - "52" + - "53" + - "54" + - "56" + - "57" + - "58" + - "59" + - 5A + - 5B + - 5C + - 5D + - 5E + - 5F + - 5G + - 5H + - 5I + - 5J + - 5K + - 5P + - 5Q + - "60" + - "61" + - "62" + - "63" + - "64" + - "65" + - "66" + - "67" + - "68" + - "69" + - "70" + - "71" + - "72" + - "73" + - "74" + - "76" + - "77" + - "78" + - "79" + - "80" + - "81" + - "82" + - "83" + - "84" + - "85" + - "86" + - "87" + - "89" + - 8C + - 8D + - 8P + - 8R + - 8S + - 8U + - "90" + - "91" + - "92" + - "93" + - "94" + - "95" + - "96" + - "97" + - "98" + - "99" + - A8 + - AA + - AB + - AC + - AD + - AE + - AF + - AG + - AH + - AI + - AJ + - AK + - AL + - AM + - AN + - AO + - AP + - AQ + - AR + - AS + - AT + - AU + - AV + - AW + - AX + - AY + - AZ + - B0 + - B1 + - B2 + - B3 + - B4 + - B5 + - B6 + - B7 + - B8 + - B9 + - BA + - BB + - BC + - BD + - BE + - BF + - BG + - BH + - BI + - BJ + - BK + - BL + - BM + - BN + - BO + - BP + - BQ + - BR + - BS + - BT + - BU + - BV + - BW + - BX + - BY + - BZ + - C0 + - C1 + - C2 + - C3 + - C4 + - C5 + - C6 + - C7 + - C8 + - C9 + - CA + - CB + - CC + - CD + - CE + - CF + - CG + - CH + - CI + - CJ + - CK + - CL + - CM + - CN + - CO + - CP + - CQ + - CR + - CS + - CT + - CU + - CV + - CW + - CX + - CY + - CZ + - D1 + - D2 + - D3 + - D5 + - D8 + - D9 + - DA + - DB + - DC + - DD + - DE + - DF + - DG + - DH + - DI + - DJ + - DK + - DL + - DM + - DN + - DO + - DP + - DQ + - DR + - DS + - DT + - DU + - DW + - DX + - DY + - DZ + - E1 + - E3 + - E4 + - E5 + - E7 + - E8 + - E9 + - EA + - EB + - EC + - ED + - EE + - EF + - EG + - EH + - EJ + - EM + - EP + - EQ + - EV + - EX + - EY + - EZ + - F1 + - F2 + - F3 + - F4 + - F5 + - F6 + - F9 + - FA + - FB + - FD + - FE + - FF + - FG + - FH + - FJ + - FK + - FL + - FM + - FO + - FP + - FR + - FS + - FT + - FZ + - G2 + - G3 + - G4 + - G5 + - G6 + - G7 + - G8 + - G9 + - GA + - GB + - GC + - GD + - GE + - GF + - GG + - GH + - GI + - GJ + - GK + - GL + - GM + - GN + - GO + - GP + - GQ + - GR + - GS + - GT + - GU + - GV + - GW + - GX + - GY + - GZ + - H1 + - H2 + - H3 + - H4 + - H5 + - H6 + - H7 + - H8 + - H9 + - HA + - HB + - HC + - HD + - HE + - HF + - HG + - HH + - HI + - HJ + - HK + - HL + - HM + - HN + - HO + - HP + - HQ + - HR + - HS + - HT + - HU + - HV + - HW + - HY + - HZ + - IA + - IB + - IC + - IE + - IF + - IG + - IH + - II + - IK + - IL + - IM + - IN + - IP + - IS + - IT + - IU + - IV + - IW + - J1 + - J2 + - J3 + - J4 + - J5 + - J6 + - J7 + - J8 + - J9 + - JA + - JB + - JC + - JE + - JG + - JK + - JL + - JM + - JN + - JO + - JP + - JR + - JS + - JT + - JU + - JV + - JX + - K1 + - K2 + - K3 + - K4 + - K5 + - K6 + - K7 + - K9 + - KA + - KB + - KC + - KD + - KE + - KF + - KG + - KH + - KI + - KJ + - KK + - KL + - KM + - KO + - KP + - KQ + - KR + - KT + - KU + - KV + - KW + - KX + - L1 + - L2 + - LA + - LB + - LC + - LE + - LF + - LG + - LH + - LI + - LJ + - LK + - LL + - LM + - LN + - LO + - LP + - LQ + - LR + - LS + - LT + - LX + - LY + - M0 + - M1 + - M2 + - M3 + - M4 + - M5 + - M6 + - M7 + - M8 + - M9 + - MA + - MB + - MC + - MD + - ME + - MF + - MG + - MH + - MI + - MJ + - MK + - ML + - MM + - MN + - MO + - MP + - MQ + - MR + - MS + - MT + - MU + - MV + - MW + - MX + - MY + - MZ + - N1 + - N2 + - N3 + - N4 + - N6 + - N7 + - N9 + - NA + - NB + - NC + - ND + - NE + - NF + - NG + - NH + - NI + - NJ + - NK + - NL + - NM + - NN + - NQ + - NR + - NS + - NT + - NU + - NV + - NW + - NX + - NY + - OA + - OC + - "ON" + - OP + - OT + - OZ + - P0 + - P1 + - P2 + - P3 + - P4 + - P5 + - P6 + - P7 + - P8 + - P9 + - PA + - PB + - PC + - PD + - PE + - PF + - PG + - PH + - PI + - PJ + - PK + - PL + - PM + - PN + - PO + - PP + - PQ + - PR + - PS + - PT + - PU + - PV + - PW + - PX + - PY + - PZ + - Q1 + - Q2 + - Q3 + - Q4 + - Q5 + - Q6 + - Q7 + - QA + - QB + - QC + - QD + - QE + - QH + - QK + - QR + - QS + - QT + - QU + - R1 + - R2 + - R3 + - R4 + - R5 + - R6 + - R7 + - R8 + - R9 + - RA + - RB + - RC + - RD + - RE + - RG + - RH + - RK + - RL + - RM + - RN + - RO + - RP + - RS + - RT + - RU + - S1 + - S2 + - S3 + - S4 + - S5 + - S6 + - S7 + - S8 + - S9 + - SA + - SB + - SC + - SD + - SE + - SF + - SG + - SH + - SI + - SJ + - SK + - SL + - SM + - SN + - SO + - SP + - SQ + - SR + - SS + - ST + - SV + - SW + - SX + - SY + - SZ + - T0 + - T1 + - T2 + - T3 + - T4 + - T5 + - T6 + - T7 + - T8 + - T9 + - TA + - TB + - TC + - TD + - TE + - TF + - TG + - TH + - TI + - TJ + - TK + - TL + - TM + - TN + - TO + - TP + - TQ + - TR + - TS + - TT + - TU + - TV + - TW + - TX + - TY + - TZ + - U1 + - U2 + - U3 + - U5 + - UA + - UB + - UC + - UD + - UE + - UF + - UH + - UL + - UM + - UN + - UP + - UQ + - UR + - US + - UT + - UU + - UV + - UW + - UX + - UY + - UZ + - V1 + - V2 + - VA + - VC + - VI + - VP + - VR + - VS + - W2 + - WA + - WB + - WD + - WE + - WG + - WH + - WI + - WK + - WM + - WP + - WR + - WW + - X1 + - X2 + - X3 + - X4 + - X5 + - X6 + - X7 + - X8 + - X9 + - XP + - Y1 + - Y2 + - Y3 + - Y4 + - YD + - YL + - YR + - YT + - Z1 + - Z2 + - Z3 + - Z4 + - Z5 + - Z6 + - Z7 + - Z8 + - Z9 + - ZA + - ZB + - ZC + - ZD + - ZE + - ZF + - ZG + - ZH + - ZI + - ZJ + - ZK + - ZL + - ZM + - ZN + - ZO + - ZP + - ZQ + - ZR + - ZS + - ZW + - ZX + - ZY + - ZZ + C001_CompositeUnitOfMeasure: + required: + - UnitorBasisforMeasurementCode_01 + type: object + properties: + UnitorBasisforMeasurementCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355' + x-freighttrust-element-id: "355" + Exponent_02: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "1018" + Multiplier_03: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "649" + UnitorBasisforMeasurementCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355' + x-freighttrust-element-id: "355" + Exponent_05: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "1018" + Multiplier_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "649" + UnitorBasisforMeasurementCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355' + x-freighttrust-element-id: "355" + Exponent_08: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "1018" + Multiplier_09: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "649" + UnitorBasisforMeasurementCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355' + x-freighttrust-element-id: "355" + Exponent_11: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "1018" + Multiplier_12: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "649" + UnitorBasisforMeasurementCode_13: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355' + x-freighttrust-element-id: "355" + Exponent_14: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "1018" + Multiplier_15: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "649" + x-freighttrust-composite-id: C001 + K3_FileInformation: + required: + - FixedFormatInformation_01 + type: object + properties: + FixedFormatInformation_01: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "449" + RecordFormatCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1333' + x-freighttrust-element-id: "1333" + CompositeUnitOfMeasure_03: + $ref: '#/components/schemas/C001_CompositeUnitOfMeasure' + x-freighttrust-segment-id: K3 + X12_ID_363_5: + type: string + enum: + - ADD + - CER + - DCP + - DGN + - TPO + NTE_ClaimNote_2: + required: + - BillingNoteText_02 + - NoteReferenceCode_01 + type: object + properties: + NoteReferenceCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_363_5' + x-freighttrust-element-id: "363" + BillingNoteText_02: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + x-freighttrust-segment-id: NTE + X12_ID_355_7: + type: string + enum: + - LB + X12_ID_1316: + type: string + enum: + - I + - R + - T + - X + X12_ID_1317_2: + type: string + enum: + - A + - B + - C + - D + - E + X12_ID_355_9: + type: string + enum: + - DH + CR1_AmbulanceTransportInformation: + required: + - AmbulanceTransportReasonCode_04 + - TransportDistance_06 + - UnitorBasisforMeasurementCode_05 + type: object + properties: + UnitorBasisforMeasurementCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355_7' + x-freighttrust-element-id: "355" + PatientWeight_02: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "81" + AmbulanceTransportCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1316' + x-freighttrust-element-id: "1316" + AmbulanceTransportReasonCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1317_2' + x-freighttrust-element-id: "1317" + UnitorBasisforMeasurementCode_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355_9' + x-freighttrust-element-id: "355" + TransportDistance_06: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + AddressInformation_07: + maxLength: 55 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "166" + AddressInformation_08: + maxLength: 55 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "166" + RoundTripPurposeDescription_09: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + StretcherPurposeDescription_10: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + x-freighttrust-syntax: + - P0102 + - P0506 + x-freighttrust-segment-id: CR1 + X12_ID_1367: + type: string + enum: + - C1 + - C2 + - C3 + - C4 + - C5 + - C6 + - C7 + - CO + - IL + - L1 + - L2 + - L3 + - L4 + - L5 + - OC + - SA + - T1 + - T10 + - T11 + - T12 + - T2 + - T3 + - T4 + - T5 + - T6 + - T7 + - T8 + - T9 + X12_ID_1342: + type: string + enum: + - A + - C + - D + - E + - F + - G + - M + CR2_SpinalManipulationServiceInformation: + required: + - PatientConditionCode_08 + type: object + properties: + Count_01: + maxLength: 9 + minLength: 1 + type: string + format: X12_N0 + x-freighttrust-element-id: "609" + Quantity_02: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + SubluxationLevelCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1367' + x-freighttrust-element-id: "1367" + SubluxationLevelCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1367' + x-freighttrust-element-id: "1367" + UnitorBasisforMeasurementCode_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355' + x-freighttrust-element-id: "355" + Quantity_06: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + Quantity_07: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + PatientConditionCode_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1342' + x-freighttrust-element-id: "1342" + YesNoConditionorResponseCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_2' + x-freighttrust-element-id: "1073" + PatientConditionDescription_10: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + PatientConditionDescription_11: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + YesNoConditionorResponseCode_12: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_2' + x-freighttrust-element-id: "1073" + x-freighttrust-syntax: + - P0102 + - C0403 + - P0506 + x-freighttrust-segment-id: CR2 + X12_ID_1136_8: + type: string + enum: + - "07" + X12_ID_1321_7: + type: string + enum: + - "01" + - "04" + - "05" + - "06" + - "07" + - "08" + - "09" + - "12" + CRC_AmbulanceCertification: + required: + - CertificationConditionIndicator_02 + - CodeCategory_01 + - ConditionCode_03 + type: object + properties: + CodeCategory_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1136_8' + x-freighttrust-element-id: "1136" + CertificationConditionIndicator_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_4' + x-freighttrust-element-id: "1073" + ConditionCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_7' + x-freighttrust-element-id: "1321" + ConditionCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_7' + x-freighttrust-element-id: "1321" + ConditionCode_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_7' + x-freighttrust-element-id: "1321" + ConditionCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_7' + x-freighttrust-element-id: "1321" + ConditionCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_7' + x-freighttrust-element-id: "1321" + x-freighttrust-segment-id: CRC + X12_ID_1136: + type: string + enum: + - E1 + - E2 + - E3 + X12_ID_1321_2: + type: string + enum: + - L1 + - L2 + - L3 + - L4 + - L5 + CRC_PatientConditionInformation: + required: + - CertificationConditionIndicator_02 + - CodeCategory_01 + - ConditionCode_03 + type: object + properties: + CodeCategory_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1136' + x-freighttrust-element-id: "1136" + CertificationConditionIndicator_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_4' + x-freighttrust-element-id: "1073" + ConditionCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_2' + x-freighttrust-element-id: "1321" + ConditionCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_2' + x-freighttrust-element-id: "1321" + ConditionCode_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_2' + x-freighttrust-element-id: "1321" + ConditionCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_2' + x-freighttrust-element-id: "1321" + ConditionCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_2' + x-freighttrust-element-id: "1321" + x-freighttrust-segment-id: CRC + X12_ID_1136_2: + type: string + enum: + - "75" + X12_ID_1321_3: + type: string + enum: + - IH + X12_ID_1321: + type: string + enum: + - "00" + - "000" + - "01" + - "02" + - "03" + - "04" + - "05" + - "06" + - "07" + - "08" + - "09" + - 0A + - 0B + - 0C + - 0D + - 0E + - 0F + - 0G + - 0H + - 0I + - 0J + - 0K + - 0L + - 0M + - 0N + - 0O + - 0P + - 0Q + - 0R + - 0S + - 0T + - 0U + - 0V + - 0W + - 0X + - 0Y + - 0Z + - "10" + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - "18" + - "19" + - 1A + - 1B + - 1C + - 1D + - 1E + - 1F + - 1G + - 1H + - 1I + - 1J + - 1K + - 1L + - 1M + - 1N + - 1O + - 1P + - 1Q + - 1R + - 1S + - 1T + - 1U + - 1V + - 1W + - 1X + - 1Y + - 1Z + - "20" + - "21" + - "22" + - "23" + - "24" + - "25" + - "26" + - "27" + - "28" + - "29" + - 2A + - 2B + - 2C + - 2D + - 2E + - 2F + - 2G + - 2H + - 2I + - 2J + - 2K + - 2L + - 2M + - 2N + - 2O + - 2P + - 2Q + - 2R + - 2S + - 2T + - 2U + - 2V + - 2W + - 2X + - 2Y + - 2Z + - "30" + - "31" + - "32" + - "33" + - "34" + - "35" + - "36" + - "37" + - "38" + - "39" + - 3A + - 3B + - 3C + - 3D + - 3E + - 3F + - 3G + - 3H + - 3I + - 3J + - 3K + - 3L + - 3M + - 3N + - 3O + - 3P + - 3Q + - 3R + - 3S + - 3T + - 3U + - 3V + - 3W + - 3X + - 3Y + - 3Z + - "40" + - "41" + - "42" + - "43" + - "44" + - "45" + - "46" + - "47" + - "48" + - "49" + - 4A + - 4B + - 4C + - 4D + - 4E + - 4F + - 4G + - 4H + - 4I + - 4J + - 4K + - 4L + - 4M + - 4N + - 4O + - 4P + - 4Q + - 4R + - 4S + - 4T + - 4U + - 4V + - 4W + - 4X + - 4Y + - 4Z + - "50" + - "51" + - "52" + - "53" + - "54" + - "55" + - "56" + - "57" + - "58" + - "59" + - 5A + - 5B + - 5C + - 5D + - 5E + - 5F + - 5G + - 5H + - 5I + - 5J + - 5K + - 5L + - 5M + - 5N + - 5O + - 5P + - 5Q + - 5R + - 5S + - 5T + - 5U + - 5V + - 5W + - 5X + - 5Y + - 5Z + - "60" + - "61" + - "62" + - "63" + - "64" + - "65" + - "66" + - "67" + - "68" + - "69" + - 6A + - 6B + - 6C + - 6D + - 6E + - 6F + - 6G + - 6H + - 6I + - 6J + - 6K + - 6L + - 6M + - 6N + - 6O + - 6P + - 6Q + - 6R + - 6S + - 6T + - 6U + - 6V + - 6W + - 6X + - 6Y + - 6Z + - "70" + - "71" + - "72" + - "73" + - "74" + - "75" + - "76" + - "77" + - "78" + - "79" + - 7A + - 7B + - 7C + - 7D + - 7E + - 7F + - 7G + - 7H + - 7I + - 7J + - 7K + - 7L + - 7M + - 7N + - 7O + - 7P + - 7Q + - 7R + - 7S + - 7T + - 7U + - 7V + - 7W + - 7X + - 7Y + - 7Z + - "80" + - "81" + - "82" + - "83" + - "84" + - "85" + - "86" + - "87" + - "88" + - "89" + - 8A + - 8B + - 8C + - 8D + - 8E + - 8F + - 8G + - 8H + - 8I + - 8J + - 8K + - 8L + - 8M + - 8N + - 8O + - 8P + - 8Q + - 8R + - 8S + - 8T + - 8U + - 8V + - 8W + - 8X + - 8Y + - 8Z + - "90" + - "91" + - "92" + - "93" + - "94" + - "95" + - "96" + - "97" + - "98" + - "99" + - 9A + - 9B + - 9C + - 9D + - 9E + - 9F + - 9G + - 9H + - 9I + - 9J + - 9K + - 9L + - 9M + - 9N + - 9O + - 9P + - 9Q + - 9R + - 9S + - 9T + - 9U + - 9V + - 9W + - 9X + - 9Y + - 9Z + - A0 + - A1 + - A2 + - A3 + - A4 + - A5 + - A6 + - A7 + - A8 + - A9 + - AA + - AB + - AC + - AD + - AE + - AF + - AFM + - AG + - AH + - AI + - AJ + - AK + - AL + - AM + - AN + - AO + - AP + - AQ + - AR + - AS + - AT + - AU + - AV + - AW + - AX + - AY + - AZ + - B0 + - B1 + - B2 + - B3 + - B4 + - B5 + - B6 + - B7 + - B8 + - B9 + - BA + - BB + - BC + - BD + - BE + - BF + - BG + - BH + - BI + - BJ + - BK + - BL + - BM + - BN + - BO + - BP + - BPD + - BQ + - BR + - BS + - BT + - BTD + - BU + - BV + - BW + - BX + - BY + - BZ + - C0 + - C1 + - C2 + - C3 + - C4 + - C5 + - C6 + - C7 + - C8 + - C9 + - CA + - CB + - CC + - CD + - CE + - CF + - CFD + - CG + - CH + - CI + - CJ + - CK + - CL + - CM + - CN + - CNJ + - CO + - CP + - CQ + - CR + - CS + - CT + - CU + - CV + - CW + - CX + - CY + - CZ + - D0 + - D1 + - D2 + - D3 + - D4 + - D5 + - D6 + - D7 + - D8 + - D9 + - DA + - DB + - DC + - DD + - DE + - DF + - DFR + - DG + - DH + - DI + - DJ + - DK + - DL + - DM + - DN + - DNR + - DO + - DP + - DQ + - DR + - DS + - DT + - DU + - DV + - DW + - DX + - DY + - DZ + - E0 + - E1 + - E2 + - E3 + - E4 + - E5 + - E6 + - E7 + - E8 + - E9 + - EA + - EB + - EC + - ED + - EE + - EF + - EG + - EH + - EI + - EJ + - EK + - EL + - EM + - EN + - EO + - EP + - EQ + - ER + - ES + - ET + - EU + - EV + - EW + - EX + - EY + - EZ + - F0 + - F1 + - F2 + - F3 + - F4 + - F5 + - F6 + - F7 + - F8 + - F9 + - FA + - FB + - FC + - FD + - FE + - FF + - FG + - FH + - FI + - FJ + - FK + - FL + - FM + - FN + - FO + - FP + - FQ + - FR + - FS + - FT + - FU + - FV + - FW + - FX + - FY + - FZ + - G0 + - G1 + - G2 + - G3 + - G4 + - G5 + - G6 + - G7 + - G8 + - G9 + - GA + - GB + - GC + - GD + - GE + - GF + - GG + - GH + - GI + - GJ + - GK + - GL + - GM + - GN + - GO + - GP + - GQ + - GR + - GS + - GT + - GU + - GV + - GW + - GX + - GY + - GZ + - H0 + - H1 + - H2 + - H3 + - H4 + - H5 + - H6 + - H7 + - H8 + - H9 + - HA + - HB + - HC + - HD + - HE + - HF + - HG + - HH + - HI + - HJ + - HK + - HL + - HM + - HN + - HO + - HP + - HQ + - HR + - HS + - HT + - HU + - HV + - HW + - HX + - HY + - HZ + - I0 + - I1 + - I2 + - I3 + - I4 + - I5 + - I6 + - I7 + - I8 + - I9 + - IA + - IB + - IC + - ID + - IE + - IF + - IG + - IH + - II + - IJ + - IK + - IL + - IM + - IN + - IO + - IP + - IQ + - IR + - IS + - IT + - IU + - IV + - IW + - IX + - IY + - IZ + - J0 + - J1 + - J2 + - J3 + - J4 + - J5 + - J6 + - J7 + - J8 + - J9 + - JA + - JB + - JC + - JCA + - JD + - JE + - JF + - JG + - JH + - JI + - JJ + - JK + - JL + - JM + - JN + - JO + - JP + - JQ + - JR + - JS + - JT + - JU + - JV + - JW + - JX + - JY + - JZ + - K0 + - K1 + - K2 + - K3 + - K4 + - K5 + - K6 + - K7 + - K8 + - K9 + - KA + - KB + - KC + - KD + - KE + - KF + - KG + - KH + - KI + - KJ + - KK + - KL + - KM + - KN + - KO + - KP + - KQ + - KR + - KS + - KT + - KU + - KV + - KW + - KX + - KY + - KZ + - L0 + - L1 + - L2 + - L3 + - L4 + - L5 + - L6 + - L7 + - L8 + - L9 + - LA + - LB + - LC + - LD + - LE + - LF + - LG + - LH + - LI + - LJ + - LK + - LL + - LM + - LN + - LO + - LP + - LQ + - LR + - LS + - LSD + - LT + - LU + - LV + - LW + - LX + - LY + - LZ + - M0 + - M1 + - M2 + - M3 + - M4 + - M5 + - M6 + - M7 + - M8 + - M9 + - MA + - MB + - MC + - MD + - ME + - MF + - MG + - MH + - MI + - MJ + - MK + - ML + - MM + - MN + - MO + - MP + - MQ + - MR + - MS + - MT + - MU + - MV + - MW + - MX + - MY + - MZ + - N0 + - N1 + - N2 + - N3 + - N4 + - N5 + - N6 + - N7 + - N8 + - N9 + - NA + - NB + - NC + - ND + - NDP + - NE + - NF + - NG + - NH + - NI + - NJ + - NK + - NL + - NM + - NN + - "NO" + - NP + - NQ + - NR + - NS + - NT + - NU + - NV + - NW + - NX + - NY + - NZ + - O0 + - O1 + - O2 + - O3 + - O4 + - O5 + - O6 + - O7 + - O8 + - O9 + - OA + - OB + - OC + - OD + - ODZ + - OE + - OF + - OG + - OH + - OI + - OJ + - OK + - OL + - OM + - "ON" + - OO + - OP + - OQ + - OR + - OS + - OT + - OU + - OV + - OW + - OX + - OY + - OZ + - P0 + - P1 + - P2 + - P3 + - P4 + - P5 + - P6 + - P7 + - P8 + - P9 + - PA + - PB + - PC + - PD + - PE + - PF + - PFB + - PG + - PH + - PI + - PJ + - PK + - PL + - PM + - PN + - PO + - PP + - PQ + - PR + - PRD + - PS + - PT + - PU + - PV + - PW + - PX + - PY + - PZ + - Q0 + - Q1 + - Q2 + - Q3 + - Q4 + - Q5 + - Q6 + - Q7 + - Q8 + - Q9 + - QA + - QB + - QC + - QD + - QE + - QF + - QG + - QH + - QI + - QJ + - QK + - QL + - QM + - QN + - QO + - QP + - QQ + - QR + - QS + - QT + - QU + - QV + - QW + - QX + - QY + - QZ + - R0 + - R1 + - R2 + - R3 + - R4 + - R5 + - R6 + - R7 + - R8 + - R9 + - RA + - RB + - RC + - RCA + - RD + - RE + - RF + - RG + - RH + - RI + - RJ + - RK + - RL + - RM + - RN + - RO + - RP + - RQ + - RR + - RS + - RT + - RU + - RV + - RW + - RX + - RY + - RZ + - S0 + - S1 + - S2 + - S3 + - S4 + - S5 + - S6 + - S7 + - S8 + - S9 + - SA + - SB + - SC + - SD + - SE + - SF + - SG + - SH + - SI + - SJ + - SK + - SL + - SM + - SN + - SO + - SP + - SPP + - SPS + - SQ + - SR + - SS + - ST + - SU + - SUB + - SV + - SW + - SX + - SY + - SZ + - T0 + - T1 + - T2 + - T3 + - T4 + - T5 + - T6 + - T7 + - T8 + - T9 + - TA + - TB + - TC + - TD + - TE + - TF + - TG + - TH + - TI + - TJ + - TK + - TL + - TM + - TN + - TNJ + - TO + - TP + - TQ + - TR + - TS + - TT + - TU + - TV + - TW + - TX + - TY + - TZ + - U0 + - U1 + - U2 + - U3 + - U4 + - U5 + - U6 + - U7 + - U8 + - U9 + - UA + - UB + - UC + - UD + - UE + - UF + - UG + - UH + - UI + - UJ + - UK + - UL + - UM + - UN + - UO + - UP + - UQ + - UR + - US + - UT + - UU + - UV + - UW + - UX + - UY + - UZ + - V0 + - V1 + - V2 + - V3 + - V4 + - V5 + - V6 + - V7 + - V8 + - V9 + - VA + - VB + - VC + - VD + - VE + - VF + - VG + - VH + - VI + - VJ + - VK + - VL + - VM + - VN + - VO + - VP + - VQ + - VR + - VS + - VT + - VTL + - VU + - VV + - VW + - VX + - VY + - VZ + - W0 + - W1 + - W2 + - W3 + - W4 + - W5 + - W6 + - W7 + - W8 + - W9 + - WA + - WB + - WC + - WD + - WE + - WF + - WG + - WH + - WI + - WJ + - WK + - WL + - WM + - WN + - WO + - WP + - WQ + - WR + - WS + - WT + - WU + - WV + - WW + - WX + - WY + - WZ + - X0 + - X1 + - X2 + - X3 + - X4 + - X5 + - X6 + - X7 + - X8 + - X9 + - XA + - XB + - XC + - XD + - XE + - XF + - XG + - XH + - XI + - XJ + - XK + - XL + - XM + - XN + - XO + - XP + - XQ + - XR + - XS + - XT + - XU + - XV + - XW + - XX + - XY + - XZ + - Y0 + - Y1 + - Y2 + - Y3 + - Y4 + - Y5 + - Y6 + - Y7 + - Y8 + - Y9 + - YA + - YB + - YC + - YD + - YE + - YF + - YG + - YH + - YI + - YJ + - YK + - YL + - YM + - YN + - YO + - YP + - YQ + - YR + - YS + - YT + - YU + - YV + - YW + - YX + - YY + - YZ + - Z0 + - Z1 + - Z2 + - Z3 + - Z4 + - Z5 + - Z6 + - Z7 + - Z8 + - Z9 + - ZA + - ZB + - ZC + - ZD + - ZE + - ZF + - ZG + - ZH + - ZI + - ZJ + - ZK + - ZL + - ZM + - ZN + - ZO + - ZP + - ZQ + - ZR + - ZS + - ZT + - ZU + - ZV + - ZW + - ZX + - ZY + - ZZ + CRC_HomeboundIndicator: + required: + - CertificationConditionIndicator_02 + - CodeCategory_01 + - ConditionCode_03 + type: object + properties: + CodeCategory_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1136_2' + x-freighttrust-element-id: "1136" + CertificationConditionIndicator_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073' + x-freighttrust-element-id: "1073" + ConditionCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_3' + x-freighttrust-element-id: "1321" + ConditionCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321' + x-freighttrust-element-id: "1321" + ConditionCode_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321' + x-freighttrust-element-id: "1321" + ConditionCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321' + x-freighttrust-element-id: "1321" + ConditionCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321' + x-freighttrust-element-id: "1321" + x-freighttrust-segment-id: CRC + X12_ID_1136_3: + type: string + enum: + - ZZ + X12_ID_1321_4: + type: string + enum: + - AV + - NU + - S2 + - ST + CRC_EPSDTReferral: + required: + - CertificationConditionIndicator_02 + - CodeCategory_01 + - ConditionCode_03 + type: object + properties: + CodeCategory_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1136_3' + x-freighttrust-element-id: "1136" + CertificationConditionIndicator_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_4' + x-freighttrust-element-id: "1073" + ConditionCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_4' + x-freighttrust-element-id: "1321" + ConditionCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_4' + x-freighttrust-element-id: "1321" + ConditionCode_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_4' + x-freighttrust-element-id: "1321" + ConditionCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321' + x-freighttrust-element-id: "1321" + ConditionCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321' + x-freighttrust-element-id: "1321" + x-freighttrust-segment-id: CRC + All_CRC_837P_2: + type: object + properties: + CRC_AmbulanceCertification: + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/CRC_AmbulanceCertification' + CRC_PatientConditionInformation_Vision: + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/CRC_PatientConditionInformation' + CRC_HomeboundIndicator: + $ref: '#/components/schemas/CRC_HomeboundIndicator' + CRC_EPSDTReferral: + $ref: '#/components/schemas/CRC_EPSDTReferral' + X12_ID_1270_6: + type: string + enum: + - ABK + - BK + X12_ID_1250: + type: string + enum: + - CC + - CD + - CM + - CQ + - CY + - D6 + - D8 + - DA + - DB + - DD + - DDT + - DT + - DTD + - DTS + - EH + - KA + - MCY + - MD + - MM + - RD + - RD2 + - RD4 + - RD5 + - RD6 + - RD8 + - RDM + - RDT + - RMD + - RMY + - RTM + - RTS + - TC + - TM + - TQ + - TR + - TS + - TT + - TU + - UN + - YM + - YMM + - YY + C022_HealthCareCodeInformation_8: + required: + - CodeListQualifierCode_01 + - IndustryCode_02 + type: object + properties: + CodeListQualifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1270_6' + x-freighttrust-element-id: "1270" + IndustryCode_02: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + DateTimePeriodFormatQualifier_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250' + x-freighttrust-element-id: "1250" + DateTimePeriod_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + MonetaryAmount_05: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + Quantity_06: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + VersionIdentifier_07: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "799" + IndustryCode_08: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + YesNoConditionorResponseCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_2' + x-freighttrust-element-id: "1073" + x-freighttrust-syntax: + - P0304 + - E0809 + x-freighttrust-composite-id: C022 + X12_ID_1270_11: + type: string + enum: + - ABF + - BF + C022_HealthCareCodeInformation_4: + required: + - CodeListQualifierCode_01 + - IndustryCode_02 + type: object + properties: + CodeListQualifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1270_11' + x-freighttrust-element-id: "1270" + IndustryCode_02: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + DateTimePeriodFormatQualifier_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250' + x-freighttrust-element-id: "1250" + DateTimePeriod_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + MonetaryAmount_05: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + Quantity_06: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + VersionIdentifier_07: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "799" + IndustryCode_08: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + YesNoConditionorResponseCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_2' + x-freighttrust-element-id: "1073" + x-freighttrust-syntax: + - P0304 + - E0809 + x-freighttrust-composite-id: C022 + C022_HealthCareCodeInformation: + required: + - CodeListQualifierCode_01 + - IndustryCode_02 + type: object + properties: + CodeListQualifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1270_28' + x-freighttrust-element-id: "1270" + IndustryCode_02: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + DateTimePeriodFormatQualifier_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250' + x-freighttrust-element-id: "1250" + DateTimePeriod_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + MonetaryAmount_05: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + Quantity_06: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + VersionIdentifier_07: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "799" + IndustryCode_08: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + YesNoConditionorResponseCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_2' + x-freighttrust-element-id: "1073" + x-freighttrust-syntax: + - P0304 + - E0809 + x-freighttrust-composite-id: C022 + HI_DependentHealthCareDiagnosisCode: + required: + - HealthCareCodeInformation_01 + type: object + properties: + HealthCareCodeInformation_01: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_8' + HealthCareCodeInformation_02: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_4' + HealthCareCodeInformation_03: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_4' + HealthCareCodeInformation_04: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_4' + HealthCareCodeInformation_05: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_4' + HealthCareCodeInformation_06: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_4' + HealthCareCodeInformation_07: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_4' + HealthCareCodeInformation_08: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_4' + HealthCareCodeInformation_09: + $ref: '#/components/schemas/C022_HealthCareCodeInformation' + HealthCareCodeInformation_10: + $ref: '#/components/schemas/C022_HealthCareCodeInformation' + HealthCareCodeInformation_11: + $ref: '#/components/schemas/C022_HealthCareCodeInformation' + HealthCareCodeInformation_12: + $ref: '#/components/schemas/C022_HealthCareCodeInformation' + x-freighttrust-segment-id: HI + X12_ID_1270_20: + type: string + enum: + - BP + C022_HealthCareCodeInformation_12: + required: + - CodeListQualifierCode_01 + - IndustryCode_02 + type: object + properties: + CodeListQualifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1270_20' + x-freighttrust-element-id: "1270" + IndustryCode_02: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + DateTimePeriodFormatQualifier_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250' + x-freighttrust-element-id: "1250" + DateTimePeriod_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + MonetaryAmount_05: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + Quantity_06: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + VersionIdentifier_07: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "799" + IndustryCode_08: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + YesNoConditionorResponseCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_2' + x-freighttrust-element-id: "1073" + x-freighttrust-syntax: + - P0304 + - E0809 + x-freighttrust-composite-id: C022 + X12_ID_1270_23: + type: string + enum: + - BO + C022_HealthCareCodeInformation_15: + required: + - CodeListQualifierCode_01 + - IndustryCode_02 + type: object + properties: + CodeListQualifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1270_23' + x-freighttrust-element-id: "1270" + IndustryCode_02: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + DateTimePeriodFormatQualifier_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250' + x-freighttrust-element-id: "1250" + DateTimePeriod_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + MonetaryAmount_05: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + Quantity_06: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + VersionIdentifier_07: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "799" + IndustryCode_08: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + YesNoConditionorResponseCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_2' + x-freighttrust-element-id: "1073" + x-freighttrust-syntax: + - P0304 + - E0809 + x-freighttrust-composite-id: C022 + HI_AnesthesiaRelatedProcedure: + required: + - HealthCareCodeInformation_01 + type: object + properties: + HealthCareCodeInformation_01: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_12' + HealthCareCodeInformation_02: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_15' + HealthCareCodeInformation_03: + $ref: '#/components/schemas/C022_HealthCareCodeInformation' + HealthCareCodeInformation_04: + $ref: '#/components/schemas/C022_HealthCareCodeInformation' + HealthCareCodeInformation_05: + $ref: '#/components/schemas/C022_HealthCareCodeInformation' + HealthCareCodeInformation_06: + $ref: '#/components/schemas/C022_HealthCareCodeInformation' + HealthCareCodeInformation_07: + $ref: '#/components/schemas/C022_HealthCareCodeInformation' + HealthCareCodeInformation_08: + $ref: '#/components/schemas/C022_HealthCareCodeInformation' + HealthCareCodeInformation_09: + $ref: '#/components/schemas/C022_HealthCareCodeInformation' + HealthCareCodeInformation_10: + $ref: '#/components/schemas/C022_HealthCareCodeInformation' + HealthCareCodeInformation_11: + $ref: '#/components/schemas/C022_HealthCareCodeInformation' + HealthCareCodeInformation_12: + $ref: '#/components/schemas/C022_HealthCareCodeInformation' + x-freighttrust-segment-id: HI + X12_ID_1270_4: + type: string + enum: + - BG + C022_HealthCareCodeInformation_13: + required: + - CodeListQualifierCode_01 + - IndustryCode_02 + type: object + properties: + CodeListQualifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1270_4' + x-freighttrust-element-id: "1270" + IndustryCode_02: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + DateTimePeriodFormatQualifier_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250' + x-freighttrust-element-id: "1250" + DateTimePeriod_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + MonetaryAmount_05: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + Quantity_06: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + VersionIdentifier_07: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "799" + IndustryCode_08: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + YesNoConditionorResponseCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_2' + x-freighttrust-element-id: "1073" + x-freighttrust-syntax: + - P0304 + - E0809 + x-freighttrust-composite-id: C022 + HI_ConditionInformation: + required: + - HealthCareCodeInformation_01 + type: object + properties: + HealthCareCodeInformation_01: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_13' + HealthCareCodeInformation_02: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_13' + HealthCareCodeInformation_03: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_13' + HealthCareCodeInformation_04: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_13' + HealthCareCodeInformation_05: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_13' + HealthCareCodeInformation_06: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_13' + HealthCareCodeInformation_07: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_13' + HealthCareCodeInformation_08: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_13' + HealthCareCodeInformation_09: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_13' + HealthCareCodeInformation_10: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_13' + HealthCareCodeInformation_11: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_13' + HealthCareCodeInformation_12: + $ref: '#/components/schemas/C022_HealthCareCodeInformation_13' + x-freighttrust-segment-id: HI + All_HI_837P: + required: + - HI_HealthCareDiagnosisCode + type: object + properties: + HI_HealthCareDiagnosisCode: + $ref: '#/components/schemas/HI_DependentHealthCareDiagnosisCode' + HI_AnesthesiaRelatedProcedure: + $ref: '#/components/schemas/HI_AnesthesiaRelatedProcedure' + HI_ConditionInformation: + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/HI_ConditionInformation' + X12_ID_1473_2: + type: string + enum: + - "00" + - "01" + - "02" + - "03" + - "04" + - "05" + - "07" + - "08" + - "09" + - "10" + - "11" + - "12" + - "13" + - "14" + X12_ID_235: + type: string + enum: + - "00" + - A1 + - A2 + - A3 + - A4 + - A5 + - A6 + - A7 + - A8 + - AA + - AB + - AC + - AD + - AE + - AF + - AG + - AH + - AI + - AJ + - AK + - AL + - AM + - AN + - AP + - AQ + - AR + - AS + - AT + - AU + - AV + - AW + - AX + - AY + - AZ + - B1 + - B2 + - B3 + - B4 + - B5 + - B6 + - B7 + - B8 + - B9 + - BA + - BB + - BC + - BD + - BE + - BF + - BG + - BH + - BI + - BJ + - BK + - BL + - BM + - BN + - BO + - BP + - BQ + - BR + - BS + - BT + - BU + - BV + - BW + - BX + - BY + - BZ + - C1 + - C2 + - C3 + - C4 + - C5 + - C6 + - C7 + - C8 + - C9 + - CA + - CB + - CC + - CD + - CE + - CF + - CG + - CH + - CI + - CJ + - CK + - CL + - CM + - CN + - CO + - CP + - CQ + - CR + - CS + - CT + - CU + - CV + - CW + - CX + - CY + - CZ + - D1 + - D2 + - D3 + - D4 + - D5 + - D6 + - D7 + - D8 + - DA + - DD + - DE + - DF + - DG + - DH + - DI + - DL + - DM + - DN + - DO + - DP + - DQ + - DR + - DS + - DT + - DU + - DV + - DW + - DX + - DY + - DZ + - E1 + - E2 + - E3 + - E4 + - E5 + - E6 + - EA + - EB + - EC + - ED + - EE + - EF + - EG + - EH + - EI + - EJ + - EK + - EL + - EM + - EN + - EO + - EP + - EQ + - ER + - ES + - EU + - EX + - EZ + - F1 + - F2 + - F3 + - F4 + - F5 + - F6 + - F7 + - F8 + - F9 + - FA + - FB + - FC + - FD + - FE + - FF + - FG + - FH + - FI + - FJ + - FK + - FL + - FM + - FN + - FP + - FQ + - FR + - FS + - FT + - FU + - FV + - FW + - FX + - GA + - GC + - GD + - GE + - GI + - GK + - GM + - GN + - GQ + - GR + - GS + - GU + - HC + - HD + - HI + - HN + - HP + - IA + - IB + - IC + - ID + - IE + - IF + - IG + - II + - IM + - IN + - IQ + - IR + - IS + - IT + - IV + - IW + - IZ + - JA + - JB + - JC + - JD + - JN + - JP + - JS + - KA + - KB + - KD + - KE + - KF + - KG + - KI + - KJ + - KK + - KL + - KM + - KN + - KP + - L1 + - L2 + - L3 + - L4 + - L5 + - L6 + - LA + - LB + - LC + - LD + - LG + - LM + - LN + - LP + - LR + - LS + - LT + - LU + - MA + - MB + - MC + - MD + - ME + - MF + - MG + - MH + - MI + - MJ + - MK + - MM + - MN + - MO + - MP + - MQ + - MR + - MS + - MT + - MU + - MV + - MW + - MX + - N1 + - N2 + - N3 + - N4 + - N5 + - N6 + - ND + - NE + - NG + - NH + - NM + - NR + - NU + - NW + - NZ + - O0 + - O7 + - O8 + - O9 + - OA + - OB + - OC + - OD + - OE + - OF + - OG + - OH + - OI + - OL + - "ON" + - OO + - OP + - OR + - OT + - OU + - P1 + - P2 + - P3 + - P4 + - P5 + - P6 + - P7 + - P8 + - P9 + - PA + - PB + - PC + - PD + - PE + - PF + - PG + - PH + - PI + - PJ + - PK + - PL + - PM + - PN + - PO + - PP + - PQ + - PR + - PS + - PT + - PU + - PV + - PW + - PX + - PY + - PZ + - R0 + - R1 + - R2 + - R3 + - R4 + - R5 + - R6 + - R7 + - R8 + - R9 + - RA + - RB + - RC + - RD + - RE + - RF + - RG + - RH + - RI + - RJ + - RK + - RL + - RM + - RN + - RO + - RP + - RQ + - RR + - RS + - RT + - RU + - RV + - RW + - RY + - RZ + - S1 + - S2 + - S3 + - S4 + - S5 + - S6 + - S7 + - S8 + - SA + - SB + - SC + - SD + - SE + - SF + - SG + - SH + - SI + - SJ + - SK + - SL + - SM + - SN + - SO + - SP + - SQ + - SR + - SS + - ST + - SU + - SV + - SW + - SX + - SY + - SZ + - T2 + - T3 + - TA + - TB + - TC + - TD + - TE + - TF + - TG + - TH + - TI + - TJ + - TK + - TM + - TN + - TP + - TR + - TS + - TT + - TU + - TV + - TW + - TX + - TY + - TZ + - U2 + - U3 + - U5 + - U6 + - UA + - UB + - UC + - UD + - UE + - UF + - UG + - UH + - UI + - UJ + - UK + - UL + - UM + - UN + - UO + - UP + - UQ + - UR + - US + - UT + - UV + - UX + - VA + - VB + - VC + - VE + - VI + - VM + - VN + - VO + - VP + - VS + - VT + - VU + - VV + - VX + - W1 + - W2 + - W5 + - W6 + - W7 + - WA + - WB + - WC + - WD + - WE + - WF + - WG + - WJ + - WK + - WL + - WR + - WS + - XA + - XC + - XP + - XQ + - XZ + - YP + - ZB + - ZR + - ZZ + X12_ID_901_15: + type: string + enum: + - T1 + - T2 + - T3 + - T4 + - T5 + - T6 + X12_ID_1526: + type: string + enum: + - "1" + - "2" + - "3" + - "4" + - "5" + X12_ID_1527: + type: string + enum: + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + HCP_ClaimPricing: + required: + - PricingMethodology_01 + - RepricedAllowedAmount_02 + type: object + properties: + PricingMethodology_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1473_2' + x-freighttrust-element-id: "1473" + RepricedAllowedAmount_02: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + RepricedSavingAmount_03: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + RepricingOrganizationIdentifier_04: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + RepricingPerDiemorFlatRateAmount_05: + maxLength: 9 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "118" + RepricedApprovedAmbulatoryPatientGroupCode_06: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + MonetaryAmount_07: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + ProductServiceID_08: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_10: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + UnitorBasisforMeasurementCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355' + x-freighttrust-element-id: "355" + Quantity_12: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + RejectReasonCode_13: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_901_15' + x-freighttrust-element-id: "901" + PolicyComplianceCode_14: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1526' + x-freighttrust-element-id: "1526" + ExceptionCode_15: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1527' + x-freighttrust-element-id: "1527" + x-freighttrust-syntax: + - R0113 + - P0910 + - P1112 + x-freighttrust-segment-id: HCP + X12_ID_98_54: + type: string + enum: + - DN + - P3 + X12_ID_1065: + type: string + enum: + - "1" + NM1_ReferringProviderName: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + - ResponseContactLastorOrganizationName_03 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_54' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_7' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + X12_ID_128_18: + type: string + enum: + - 0B + - 1G + - G2 + X12_ID_128_27: + type: string + enum: + - 2U + C040_ReferenceIdentifier_3: + required: + - ReferenceIdentificationQualifier_01 + - ReferenceIdentification_02 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_27' + x-freighttrust-element-id: "128" + ReferenceIdentification_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + ReferenceIdentificationQualifier_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_20' + x-freighttrust-element-id: "128" + ReferenceIdentification_04: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + ReferenceIdentificationQualifier_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_20' + x-freighttrust-element-id: "128" + ReferenceIdentification_06: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + x-freighttrust-syntax: + - P0304 + - P0506 + x-freighttrust-composite-id: C040 + REF_OrderingProviderSecondaryIdentification: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_18' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier_3' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + Loop_2310A_837P: + required: + - NM1_ReferringProviderName + type: object + properties: + NM1_ReferringProviderName: + $ref: '#/components/schemas/NM1_ReferringProviderName' + REF_ReferringProviderSecondaryIdentification: + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/REF_OrderingProviderSecondaryIdentification' + x-freighttrust-loop-id: 2310A + X12_ID_98_2: + type: string + enum: + - "82" + NM1_RenderingProviderName: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + - ResponseContactLastorOrganizationName_03 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_2' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_2' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_7' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + X12_ID_1221_5: + type: string + enum: + - PE + PRV_RenderingProviderSpecialtyInformation: + required: + - ProviderCode_01 + - ProviderTaxonomyCode_03 + - ReferenceIdentificationQualifier_02 + type: object + properties: + ProviderCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1221_5' + x-freighttrust-element-id: "1221" + ReferenceIdentificationQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_35' + x-freighttrust-element-id: "128" + ProviderTaxonomyCode_03: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + StateorProvinceCode_04: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "156" + ProviderSpecialtyInformation_05: + $ref: '#/components/schemas/C035_ProviderSpecialtyInformation' + ProviderOrganizationCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1223' + x-freighttrust-element-id: "1223" + x-freighttrust-syntax: + - P0203 + x-freighttrust-segment-id: PRV + X12_ID_128_23: + type: string + enum: + - 0B + - 1G + - G2 + - LU + REF_AssistantSurgeonSecondaryIdentification: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_23' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier_3' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + Loop_2310B_837P: + required: + - NM1_RenderingProviderName + type: object + properties: + NM1_RenderingProviderName: + $ref: '#/components/schemas/NM1_RenderingProviderName' + PRV_RenderingProviderSpecialtyInformation: + $ref: '#/components/schemas/PRV_RenderingProviderSpecialtyInformation' + REF_RenderingProviderSecondaryIdentification: + maxItems: 4 + type: array + items: + $ref: '#/components/schemas/REF_AssistantSurgeonSecondaryIdentification' + x-freighttrust-loop-id: 2310B + X12_ID_98_5: + type: string + enum: + - "77" + NM1_ServiceFacilityLocation: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + - ResponseContactLastorOrganizationName_03 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_5' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_3' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_7' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + X12_ID_128_25: + type: string + enum: + - 0B + - G2 + - LU + REF_OtherPayerServiceFacilityLocationSecondaryIdentification: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_25' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + Loop_2310C_837P: + required: + - N3_ServiceFacilityLocationAddress + - N4_ServiceFacilityLocationCity_State_ZIPCode + - NM1_ServiceFacilityLocationName + type: object + properties: + NM1_ServiceFacilityLocationName: + $ref: '#/components/schemas/NM1_ServiceFacilityLocation' + N3_ServiceFacilityLocationAddress: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_ServiceFacilityLocationCity_State_ZIPCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + REF_ServiceFacilityLocationSecondaryIdentification: + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/REF_OtherPayerServiceFacilityLocationSecondaryIdentification' + PER_ServiceFacilityContactInformation: + $ref: '#/components/schemas/PER_PropertyandCasualtyPatientContactInformation' + x-freighttrust-loop-id: 2310C + X12_ID_98_9: + type: string + enum: + - DQ + NM1_SupervisingProviderName: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + - ResponseContactLastorOrganizationName_03 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_9' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_7' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + Loop_2310D_837P: + required: + - NM1_SupervisingProviderName + type: object + properties: + NM1_SupervisingProviderName: + $ref: '#/components/schemas/NM1_SupervisingProviderName' + REF_SupervisingProviderSecondaryIdentification: + maxItems: 4 + type: array + items: + $ref: '#/components/schemas/REF_AssistantSurgeonSecondaryIdentification' + x-freighttrust-loop-id: 2310D + X12_ID_98_11: + type: string + enum: + - PW + NM1_AmbulancePick: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_11' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_3' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_12' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + Loop_2310E_837P: + required: + - N3_AmbulancePick_LocationAddress + - N4_AmbulancePick_LocationCity_State_ZipCode + - NM1_AmbulancePick_Location + type: object + properties: + NM1_AmbulancePick_Location: + $ref: '#/components/schemas/NM1_AmbulancePick' + N3_AmbulancePick_LocationAddress: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_AmbulancePick_LocationCity_State_ZipCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + x-freighttrust-loop-id: 2310E + X12_ID_98_7: + type: string + enum: + - "45" + NM1_AmbulanceDrop: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_7' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_3' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_12' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + Loop_2310F_837P: + required: + - N3_AmbulanceDrop_LocationAddress + - N4_AmbulanceDrop_LocationCity_State_ZipCode + - NM1_AmbulanceDrop_Location + type: object + properties: + NM1_AmbulanceDrop_Location: + $ref: '#/components/schemas/NM1_AmbulanceDrop' + N3_AmbulanceDrop_LocationAddress: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_AmbulanceDrop_LocationCity_State_ZipCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + x-freighttrust-loop-id: 2310F + All_NM1_837P_3: + type: object + properties: + Loop2310A: + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/Loop_2310A_837P' + Loop2310B: + $ref: '#/components/schemas/Loop_2310B_837P' + Loop2310C: + $ref: '#/components/schemas/Loop_2310C_837P' + Loop2310D: + $ref: '#/components/schemas/Loop_2310D_837P' + Loop2310E: + $ref: '#/components/schemas/Loop_2310E_837P' + Loop2310F: + $ref: '#/components/schemas/Loop_2310F_837P' + X12_ID_1069_4: + type: string + enum: + - "01" + - "18" + - "19" + - "20" + - "21" + - "39" + - "40" + - "53" + - G8 + SBR_OtherSubscriberInformation: + required: + - IndividualRelationshipCode_02 + - PayerResponsibilitySequenceNumberCode_01 + type: object + properties: + PayerResponsibilitySequenceNumberCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1138_2' + x-freighttrust-element-id: "1138" + IndividualRelationshipCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1069_4' + x-freighttrust-element-id: "1069" + InsuredGrouporPolicyNumber_03: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + OtherInsuredGroupName_04: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "93" + InsuranceTypeCode_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1336_3' + x-freighttrust-element-id: "1336" + CoordinationofBenefitsCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1143_2' + x-freighttrust-element-id: "1143" + YesNoConditionorResponseCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_2' + x-freighttrust-element-id: "1073" + EmploymentStatusCode_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_584_2' + x-freighttrust-element-id: "584" + ClaimFilingIndicatorCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1032_3' + x-freighttrust-element-id: "1032" + x-freighttrust-segment-id: SBR + X12_ID_1033_2: + type: string + enum: + - CO + - CR + - OA + - PI + - PR + CAS_ClaimLevelAdjustments: + required: + - AdjustmentAmount_03 + - AdjustmentReasonCode_02 + - ClaimAdjustmentGroupCode_01 + type: object + properties: + ClaimAdjustmentGroupCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1033_2' + x-freighttrust-element-id: "1033" + AdjustmentReasonCode_02: + maxLength: 5 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1034" + AdjustmentAmount_03: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + AdjustmentQuantity_04: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + AdjustmentReasonCode_05: + maxLength: 5 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1034" + AdjustmentAmount_06: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + AdjustmentQuantity_07: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + AdjustmentReasonCode_08: + maxLength: 5 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1034" + AdjustmentAmount_09: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + AdjustmentQuantity_10: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + AdjustmentReasonCode_11: + maxLength: 5 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1034" + AdjustmentAmount_12: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + AdjustmentQuantity_13: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + AdjustmentReasonCode_14: + maxLength: 5 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1034" + AdjustmentAmount_15: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + AdjustmentQuantity_16: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + AdjustmentReasonCode_17: + maxLength: 5 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1034" + AdjustmentAmount_18: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + AdjustmentQuantity_19: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + x-freighttrust-syntax: + - L050607 + - C0605 + - C0705 + - L080910 + - C0908 + - C1008 + - L111213 + - C1211 + - C1311 + - L141516 + - C1514 + - C1614 + - L171819 + - C1817 + - C1917 + x-freighttrust-segment-id: CAS + X12_ID_522_4: + type: string + enum: + - D + AMT_CoordinationofBenefits: + required: + - AmountQualifierCode_01 + - TotalClaimChargeAmount_02 + type: object + properties: + AmountQualifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_522_4' + x-freighttrust-element-id: "522" + TotalClaimChargeAmount_02: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + CreditDebitFlagCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_478' + x-freighttrust-element-id: "478" + x-freighttrust-segment-id: AMT + X12_ID_522_6: + type: string + enum: + - A8 + AMT_CoordinationofBenefits_2: + required: + - AmountQualifierCode_01 + - TotalClaimChargeAmount_02 + type: object + properties: + AmountQualifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_522_6' + x-freighttrust-element-id: "522" + TotalClaimChargeAmount_02: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + CreditDebitFlagCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_478' + x-freighttrust-element-id: "478" + x-freighttrust-segment-id: AMT + X12_ID_522_5: + type: string + enum: + - EAF + AMT_RemainingPatientLiability: + required: + - AmountQualifierCode_01 + - TotalClaimChargeAmount_02 + type: object + properties: + AmountQualifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_522_5' + x-freighttrust-element-id: "522" + TotalClaimChargeAmount_02: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + CreditDebitFlagCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_478' + x-freighttrust-element-id: "478" + x-freighttrust-segment-id: AMT + All_AMT_837P_2: + type: object + properties: + AMT_CoordinationofBenefits_COB_PayerPaidAmount: + $ref: '#/components/schemas/AMT_CoordinationofBenefits' + AMT_CoordinationofBenefits_COB_TotalNon_Amount: + $ref: '#/components/schemas/AMT_CoordinationofBenefits_2' + AMT_RemainingPatientLiability: + $ref: '#/components/schemas/AMT_RemainingPatientLiability' + OI_OtherInsuranceCoverageInformation_2: + required: + - BenefitsAssignmentCertificationIndicator_03 + - ReleaseofInformationCode_06 + type: object + properties: + ClaimFilingIndicatorCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1032' + x-freighttrust-element-id: "1032" + ClaimSubmissionReasonCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1383' + x-freighttrust-element-id: "1383" + BenefitsAssignmentCertificationIndicator_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_5' + x-freighttrust-element-id: "1073" + PatientSignatureSourceCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1351' + x-freighttrust-element-id: "1351" + ProviderAgreementCode_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1360' + x-freighttrust-element-id: "1360" + ReleaseofInformationCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1363_2' + x-freighttrust-element-id: "1363" + x-freighttrust-segment-id: OI + MOA_OutpatientAdjudicationInformation: + type: object + properties: + ReimbursementRate_01: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "954" + HCPCSPayableAmount_02: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + ClaimPaymentRemarkCode_03: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + ClaimPaymentRemarkCode_04: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + ClaimPaymentRemarkCode_05: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + ClaimPaymentRemarkCode_06: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + ClaimPaymentRemarkCode_07: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + MonetaryAmount_08: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + NonPayableProfessionalComponentBilledAmount_09: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + x-freighttrust-segment-id: MOA + NM1_OtherSubscriberName: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + - IdentificationCodeQualifier_08 + - ResponseContactIdentifier_09 + - ResponseContactLastorOrganizationName_03 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_26' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_2' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_8' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + Loop_2330A_837P: + required: + - NM1_OtherSubscriberName + type: object + properties: + NM1_OtherSubscriberName: + $ref: '#/components/schemas/NM1_OtherSubscriberName' + N3_OtherSubscriberAddress: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_OtherSubscriberCity_State_ZIPCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + REF_OtherSubscriberSecondaryIdentification: + $ref: '#/components/schemas/REF_OtherSubscriberSecondaryIdentification' + x-freighttrust-loop-id: 2330A + X12_ID_374_12: + type: string + enum: + - "573" + DTP_ClaimCheckOrRemittanceDate: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_12' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_128_26: + type: string + enum: + - T4 + REF_OtherPayerClaimAdjustmentIndicator: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_26' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + All_REF_837P: + type: object + properties: + REF_OtherPayerSecondaryIdentifier: + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/REF_OtherPayerSecondaryIdentifier' + REF_OtherPayerPriorAuthorizationNumber: + $ref: '#/components/schemas/REF_OtherPayerPriorAuthorizationNumber' + REF_OtherPayerReferralNumber: + $ref: '#/components/schemas/REF_OtherPayerReferralNumber' + REF_OtherPayerClaimAdjustmentIndicator: + $ref: '#/components/schemas/REF_OtherPayerClaimAdjustmentIndicator' + REF_OtherPayerClaimControlNumber: + $ref: '#/components/schemas/REF_OtherPayerClaimControlNumber' + Loop_2330B_837P: + required: + - NM1_OtherPayerName + type: object + properties: + NM1_OtherPayerName: + $ref: '#/components/schemas/NM1_OtherPayerName' + N3_OtherPayerAddress: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_OtherPayerCity_State_ZIPCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + DTP_ClaimCheckorRemittanceDate: + $ref: '#/components/schemas/DTP_ClaimCheckOrRemittanceDate' + AllREF: + $ref: '#/components/schemas/All_REF_837P' + x-freighttrust-loop-id: 2330B + NM1_OtherPayerReferringProvider: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_54' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_12' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + Loop_2330C_837P: + required: + - NM1_OtherPayerReferringProvider + - REF_OtherPayerReferringProviderSecondaryIdentification + type: object + properties: + NM1_OtherPayerReferringProvider: + $ref: '#/components/schemas/NM1_OtherPayerReferringProvider' + REF_OtherPayerReferringProviderSecondaryIdentification: + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/REF_OrderingProviderSecondaryIdentification' + x-freighttrust-loop-id: 2330C + NM1_OtherPayerRenderingProvider_2: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_2' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_2' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_12' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + Loop_2330D_837P: + required: + - NM1_OtherPayerRenderingProvider + - REF_OtherPayerRenderingProviderSecondaryIdentification + type: object + properties: + NM1_OtherPayerRenderingProvider: + $ref: '#/components/schemas/NM1_OtherPayerRenderingProvider_2' + REF_OtherPayerRenderingProviderSecondaryIdentification: + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/REF_AssistantSurgeonSecondaryIdentification' + x-freighttrust-loop-id: 2330D + NM1_OtherPayerServiceFacilityLocation: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_5' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_3' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_12' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + Loop_2330E_837P: + required: + - NM1_OtherPayerServiceFacilityLocation + - REF_OtherPayerServiceFacilityLocationSecondaryIdentification + type: object + properties: + NM1_OtherPayerServiceFacilityLocation: + $ref: '#/components/schemas/NM1_OtherPayerServiceFacilityLocation' + REF_OtherPayerServiceFacilityLocationSecondaryIdentification: + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/REF_OtherPayerServiceFacilityLocationSecondaryIdentification' + x-freighttrust-loop-id: 2330E + NM1_OtherPayerSupervisingProvider: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_9' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_12' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + Loop_2330F_837P: + required: + - NM1_OtherPayerSupervisingProvider + - REF_OtherPayerSupervisingProviderSecondaryIdentification + type: object + properties: + NM1_OtherPayerSupervisingProvider: + $ref: '#/components/schemas/NM1_OtherPayerSupervisingProvider' + REF_OtherPayerSupervisingProviderSecondaryIdentification: + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/REF_AssistantSurgeonSecondaryIdentification' + x-freighttrust-loop-id: 2330F + NM1_OtherPayerBillingProvider: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_31' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_2' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_12' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + Loop_2330G_837P: + required: + - NM1_OtherPayerBillingProvider + - REF_OtherPayerBillingProviderSecondaryIdentification + type: object + properties: + NM1_OtherPayerBillingProvider: + $ref: '#/components/schemas/NM1_OtherPayerBillingProvider' + REF_OtherPayerBillingProviderSecondaryIdentification: + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/REF_BillingProviderSecondaryIdentification' + x-freighttrust-loop-id: 2330G + All_NM1_837P_4: + required: + - Loop2330A + - Loop2330B + type: object + properties: + Loop2330A: + $ref: '#/components/schemas/Loop_2330A_837P' + Loop2330B: + $ref: '#/components/schemas/Loop_2330B_837P' + Loop2330C: + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/Loop_2330C_837P' + Loop2330D: + $ref: '#/components/schemas/Loop_2330D_837P' + Loop2330E: + $ref: '#/components/schemas/Loop_2330E_837P' + Loop2330F: + $ref: '#/components/schemas/Loop_2330F_837P' + Loop2330G: + $ref: '#/components/schemas/Loop_2330G_837P' + Loop_2320_837P: + required: + - AllNM1 + - OI_OtherInsuranceCoverageInformation + - SBR_OtherSubscriberInformation + type: object + properties: + SBR_OtherSubscriberInformation: + $ref: '#/components/schemas/SBR_OtherSubscriberInformation' + CAS_ClaimLevelAdjustments: + maxItems: 5 + type: array + items: + $ref: '#/components/schemas/CAS_ClaimLevelAdjustments' + AllAMT: + $ref: '#/components/schemas/All_AMT_837P_2' + OI_OtherInsuranceCoverageInformation: + $ref: '#/components/schemas/OI_OtherInsuranceCoverageInformation_2' + MOA_OutpatientAdjudicationInformation: + $ref: '#/components/schemas/MOA_OutpatientAdjudicationInformation' + AllNM1: + $ref: '#/components/schemas/All_NM1_837P_4' + x-freighttrust-loop-id: "2320" + LX_HeaderNumber: + required: + - AssignedNumber_01 + type: object + properties: + AssignedNumber_01: + maxLength: 6 + minLength: 1 + type: string + format: X12_N0 + x-freighttrust-element-id: "554" + x-freighttrust-segment-id: LX + X12_ID_235_6: + type: string + enum: + - ER + - HC + - IV + - WK + C003_CompositeMedicalProcedureIdentifier_12: + required: + - ProcedureCode_02 + - ProductorServiceIDQualifier_01 + type: object + properties: + ProductorServiceIDQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235_6' + x-freighttrust-element-id: "235" + ProcedureCode_02: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProcedureModifier_03: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "1339" + ProcedureModifier_04: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "1339" + ProcedureModifier_05: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "1339" + ProcedureModifier_06: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "1339" + Description_07: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ProductServiceID_08: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + x-freighttrust-composite-id: C003 + X12_ID_355_11: + type: string + enum: + - MJ + - UN + X12_ID_1365_2: + type: string + enum: + - "1" + - "10" + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - "18" + - "19" + - "2" + - "20" + - "21" + - "22" + - "23" + - "24" + - "25" + - "26" + - "27" + - "28" + - "3" + - "30" + - "31" + - "32" + - "33" + - "34" + - "35" + - "36" + - "37" + - "38" + - "39" + - "4" + - "40" + - "41" + - "42" + - "43" + - "44" + - "45" + - "46" + - "47" + - "48" + - "49" + - "5" + - "50" + - "51" + - "52" + - "53" + - "54" + - "55" + - "56" + - "57" + - "58" + - "59" + - "6" + - "60" + - "61" + - "62" + - "63" + - "64" + - "65" + - "66" + - "67" + - "68" + - "69" + - "7" + - "70" + - "71" + - "72" + - "73" + - "74" + - "75" + - "76" + - "77" + - "78" + - "79" + - "8" + - "80" + - "81" + - "82" + - "83" + - "84" + - "85" + - "86" + - "87" + - "88" + - "89" + - "9" + - "90" + - "91" + - "92" + - "93" + - "94" + - "95" + - "96" + - "97" + - "98" + - "99" + - A0 + - A1 + - A2 + - A3 + - A4 + - A5 + - A6 + - A7 + - A8 + - A9 + - AA + - AB + - AC + - AD + - AE + - AF + - AG + - AH + - AI + - AJ + - AK + - AL + - AM + - AN + - AO + - AQ + - AR + - B + - B1 + - B2 + - B3 + - BA + - BB + - BC + - BD + - BE + - BF + - BG + - BH + - BI + - BJ + - BK + - BL + - BM + - BN + - BP + - BQ + - BR + - BS + - BT + - BU + - BV + - BW + - BX + - BY + - BZ + - C + - C1 + - CA + - CB + - CC + - CD + - CE + - CF + - CG + - CH + - CI + - CJ + - CK + - CL + - CM + - CN + - CO + - CP + - CQ + - DG + - DM + - DS + - GF + - GN + - GY + - IC + - MH + - NI + - "ON" + - PT + - PU + - RN + - RT + - TC + - TN + - UC + C004_CompositeDiagnosisCodePointer: + required: + - DiagnosisCodePointer_01 + type: object + properties: + DiagnosisCodePointer_01: + maxLength: 2 + minLength: 1 + type: string + format: X12_N0 + x-freighttrust-element-id: "1328" + DiagnosisCodePointer_02: + maxLength: 2 + minLength: 1 + type: string + format: X12_N0 + x-freighttrust-element-id: "1328" + DiagnosisCodePointer_03: + maxLength: 2 + minLength: 1 + type: string + format: X12_N0 + x-freighttrust-element-id: "1328" + DiagnosisCodePointer_04: + maxLength: 2 + minLength: 1 + type: string + format: X12_N0 + x-freighttrust-element-id: "1328" + x-freighttrust-composite-id: C004 + X12_ID_1340: + type: string + enum: + - "N" + - P + - S + X12_ID_1364: + type: string + enum: + - A + - B + - C + - D + - E + - F + - L + - "N" + X12_ID_1327_2: + type: string + enum: + - "0" + X12_ID_1337: + type: string + enum: + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + SV1_ProfessionalService: + required: + - CompositeDiagnosisCodePointer_07 + - CompositeMedicalProcedureIdentifier_01 + - LineItemChargeAmount_02 + - ServiceUnitCount_04 + - UnitorBasisforMeasurementCode_03 + type: object + properties: + CompositeMedicalProcedureIdentifier_01: + $ref: '#/components/schemas/C003_CompositeMedicalProcedureIdentifier_12' + LineItemChargeAmount_02: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + UnitorBasisforMeasurementCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355_11' + x-freighttrust-element-id: "355" + ServiceUnitCount_04: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + PlaceofServiceCode_05: + maxLength: 2 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1331" + ServiceTypeCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1365_2' + x-freighttrust-element-id: "1365" + CompositeDiagnosisCodePointer_07: + $ref: '#/components/schemas/C004_CompositeDiagnosisCodePointer' + MonetaryAmount_08: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + EmergencyIndicator_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073' + x-freighttrust-element-id: "1073" + MultipleProcedureCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1340' + x-freighttrust-element-id: "1340" + EPSDTIndicator_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073' + x-freighttrust-element-id: "1073" + FamilyPlanningIndicator_12: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073' + x-freighttrust-element-id: "1073" + ReviewCode_13: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1364' + x-freighttrust-element-id: "1364" + NationalorLocalAssignedReviewValue_14: + maxLength: 2 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1341" + CoPayStatusCode_15: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1327_2' + x-freighttrust-element-id: "1327" + HealthCareProfessionalShortageAreaCode_16: + maxLength: 1 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1334" + ReferenceIdentification_17: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + PostalCode_18: + maxLength: 15 + minLength: 3 + type: string + format: X12_AN + x-freighttrust-element-id: "116" + MonetaryAmount_19: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + LevelofCareCode_20: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1337' + x-freighttrust-element-id: "1337" + ProviderAgreementCode_21: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1360' + x-freighttrust-element-id: "1360" + x-freighttrust-syntax: + - P0304 + x-freighttrust-segment-id: SV1 + X12_ID_235_10: + type: string + enum: + - HC + C003_CompositeMedicalProcedureIdentifier_9: + required: + - ProcedureCode_02 + - ProductorServiceIDQualifier_01 + type: object + properties: + ProductorServiceIDQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235_10' + x-freighttrust-element-id: "235" + ProcedureCode_02: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProcedureModifier_03: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "1339" + ProcedureModifier_04: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "1339" + ProcedureModifier_05: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "1339" + ProcedureModifier_06: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "1339" + Description_07: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ProductServiceID_08: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + x-freighttrust-composite-id: C003 + X12_ID_355_12: + type: string + enum: + - DA + X12_ID_594_2: + type: string + enum: + - "1" + - "4" + - "6" + X12_ID_923: + type: string + enum: + - "1" + - "2" + - "3" + - "4" + - "5" + - "6" + - "7" + - "8" + SV5_DurableMedicalEquipmentService: + required: + - CompositeMedicalProcedureIdentifier_01 + - DMEPurchasePrice_05 + - DMERentalPrice_04 + - LengthofMedicalNecessity_03 + - RentalUnitPriceIndicator_06 + - UnitorBasisforMeasurementCode_02 + type: object + properties: + CompositeMedicalProcedureIdentifier_01: + $ref: '#/components/schemas/C003_CompositeMedicalProcedureIdentifier_9' + UnitorBasisforMeasurementCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355_12' + x-freighttrust-element-id: "355" + LengthofMedicalNecessity_03: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + DMERentalPrice_04: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + DMEPurchasePrice_05: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + RentalUnitPriceIndicator_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_594_2' + x-freighttrust-element-id: "594" + PrognosisCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_923' + x-freighttrust-element-id: "923" + x-freighttrust-syntax: + - R0405 + - C0604 + x-freighttrust-segment-id: SV5 + X12_ID_755: + type: string + enum: + - "03" + - "04" + - "05" + - "06" + - "07" + - "08" + - "09" + - "10" + - "11" + - "13" + - "15" + - "21" + - A3 + - A4 + - AM + - AS + - B2 + - B3 + - B4 + - BR + - BS + - BT + - CB + - CK + - CT + - D2 + - DA + - DB + - DG + - DJ + - DS + - EB + - HC + - HR + - I5 + - IR + - LA + - M1 + - MT + - NN + - OB + - OC + - OD + - OE + - OX + - OZ + - P4 + - P5 + - PE + - PN + - PO + - PQ + - PY + - PZ + - RB + - RR + - RT + - RX + - SG + - V5 + - XP + PWK_ClaimSupplementalInformation_2: + required: + - AttachmentReportTypeCode_01 + - ReportTransmissionCode_02 + type: object + properties: + AttachmentReportTypeCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_755' + x-freighttrust-element-id: "755" + ReportTransmissionCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_756_5' + x-freighttrust-element-id: "756" + ReportCopiesNeeded_03: + maxLength: 2 + minLength: 1 + type: string + format: X12_N0 + x-freighttrust-element-id: "757" + EntityIdentifierCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + IdentificationCodeQualifier_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_16' + x-freighttrust-element-id: "66" + AttachmentControlNumber_06: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + AttachmentDescription_07: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ActionsIndicated_08: + $ref: '#/components/schemas/C002_ActionsIndicated_2' + RequestCategoryCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1525' + x-freighttrust-element-id: "1525" + x-freighttrust-syntax: + - P0506 + x-freighttrust-segment-id: PWK + X12_ID_755_2: + type: string + enum: + - CT + X12_ID_756: + type: string + enum: + - AB + - AD + - AF + - AG + - NS + PWK_DurableMedicalEquipmentCertificateofMedicalNecessityIndicator: + required: + - AttachmentReportTypeCode_01 + - ReportTransmissionCode_02 + type: object + properties: + AttachmentReportTypeCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_755_2' + x-freighttrust-element-id: "755" + ReportTransmissionCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_756' + x-freighttrust-element-id: "756" + ReportCopiesNeeded_03: + maxLength: 2 + minLength: 1 + type: string + format: X12_N0 + x-freighttrust-element-id: "757" + EntityIdentifierCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + IdentificationCodeQualifier_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_12' + x-freighttrust-element-id: "66" + AttachmentControlNumber_06: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + AttachmentDescription_07: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ActionsIndicated_08: + $ref: '#/components/schemas/C002_ActionsIndicated_2' + RequestCategoryCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1525' + x-freighttrust-element-id: "1525" + x-freighttrust-syntax: + - P0506 + x-freighttrust-segment-id: PWK + All_PWK_837P: + type: object + properties: + PWK_LineSupplementalInformation: + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/PWK_ClaimSupplementalInformation_2' + PWK_DurableMedicalEquipmentCertificateofMedicalNecessityIndicator: + $ref: '#/components/schemas/PWK_DurableMedicalEquipmentCertificateofMedicalNecessityIndicator' + X12_ID_1322_4: + type: string + enum: + - I + - R + - S + X12_ID_355_13: + type: string + enum: + - MO + X12_ID_1335: + type: string + enum: + - "1" + - "2" + - "3" + - "N" + CR3_DurableMedicalEquipmentCertification: + required: + - CertificationTypeCode_01 + - DurableMedicalEquipmentDuration_03 + - UnitorBasisforMeasurementCode_02 + type: object + properties: + CertificationTypeCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1322_4' + x-freighttrust-element-id: "1322" + UnitorBasisforMeasurementCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355_13' + x-freighttrust-element-id: "355" + DurableMedicalEquipmentDuration_03: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + InsulinDependentCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1335' + x-freighttrust-element-id: "1335" + Description_05: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + x-freighttrust-syntax: + - P0203 + x-freighttrust-segment-id: CR3 + X12_ID_1136_4: + type: string + enum: + - "70" + X12_ID_1321_5: + type: string + enum: + - "65" + CRC_HospiceEmployeeIndicator: + required: + - CertificationConditionIndicator_02 + - CodeCategory_01 + - ConditionCode_03 + type: object + properties: + CodeCategory_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1136_4' + x-freighttrust-element-id: "1136" + CertificationConditionIndicator_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_4' + x-freighttrust-element-id: "1073" + ConditionCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_5' + x-freighttrust-element-id: "1321" + ConditionCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321' + x-freighttrust-element-id: "1321" + ConditionCode_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321' + x-freighttrust-element-id: "1321" + ConditionCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321' + x-freighttrust-element-id: "1321" + ConditionCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321' + x-freighttrust-element-id: "1321" + x-freighttrust-segment-id: CRC + X12_ID_1136_5: + type: string + enum: + - "09" + X12_ID_1321_6: + type: string + enum: + - "38" + - ZV + CRC_ConditionIndicator: + required: + - CertificationConditionIndicator_02 + - CodeCategory_01 + - ConditionCode_03 + type: object + properties: + CodeCategory_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1136_5' + x-freighttrust-element-id: "1136" + CertificationConditionIndicator_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_4' + x-freighttrust-element-id: "1073" + ConditionCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_6' + x-freighttrust-element-id: "1321" + ConditionCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321_6' + x-freighttrust-element-id: "1321" + ConditionCode_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321' + x-freighttrust-element-id: "1321" + ConditionCode_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321' + x-freighttrust-element-id: "1321" + ConditionCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1321' + x-freighttrust-element-id: "1321" + x-freighttrust-segment-id: CRC + All_CRC_837P: + type: object + properties: + CRC_AmbulanceCertification: + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/CRC_AmbulanceCertification' + CRC_HospiceEmployeeIndicator: + $ref: '#/components/schemas/CRC_HospiceEmployeeIndicator' + CRC_ConditionIndicator_DurableMedicalEquipment: + $ref: '#/components/schemas/CRC_ConditionIndicator' + X12_ID_374_4: + type: string + enum: + - "472" + DTP_ClaimLevelServiceDate: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_4' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_2' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_21: + type: string + enum: + - "607" + DTP_CertificationRevision: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_21' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_22: + type: string + enum: + - "463" + DTP_BeginTherapyDate: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_22' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_23: + type: string + enum: + - "461" + DTP_LastCertificationDate: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_23' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_24: + type: string + enum: + - "738" + - "739" + DTP_TestDate: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_24' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + X12_ID_374_25: + type: string + enum: + - "011" + DTP_ShippedDate: + required: + - DateTimePeriodFormatQualifier_02 + - DateTimePeriod_03 + - DateTimeQualifier_01 + type: object + properties: + DateTimeQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_374_25' + x-freighttrust-element-id: "374" + DateTimePeriodFormatQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + DateTimePeriod_03: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + x-freighttrust-segment-id: DTP + All_DTP_837P: + required: + - DTP_Date_ServiceDate + type: object + properties: + DTP_Date_ServiceDate: + $ref: '#/components/schemas/DTP_ClaimLevelServiceDate' + DTP_Date_PrescriptionDate: + $ref: '#/components/schemas/DTP_HearingandVisionPrescriptionDate' + DTP_DATE_CertificationRevision_RecertificationDate: + $ref: '#/components/schemas/DTP_CertificationRevision' + DTP_Date_BeginTherapyDate: + $ref: '#/components/schemas/DTP_BeginTherapyDate' + DTP_Date_LastCertificationDate: + $ref: '#/components/schemas/DTP_LastCertificationDate' + DTP_Date_LastSeenDate: + $ref: '#/components/schemas/DTP_LastSeenDate' + DTP_Date_TestDate: + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/DTP_TestDate' + DTP_Date_ShippedDate: + $ref: '#/components/schemas/DTP_ShippedDate' + DTP_Date_LastX_Date: + $ref: '#/components/schemas/DTP_LastXrayDate' + DTP_Date_InitialTreatmentDate: + $ref: '#/components/schemas/DTP_InitialTreatmentDate' + X12_ID_673_11: + type: string + enum: + - PT + QTY_AmbulancePatientCount: + required: + - AmbulancePatientCount_02 + - QuantityQualifier_01 + type: object + properties: + QuantityQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_673_11' + x-freighttrust-element-id: "673" + AmbulancePatientCount_02: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + CompositeUnitOfMeasure_03: + $ref: '#/components/schemas/C001_CompositeUnitOfMeasure' + FreeformInformation_04: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "61" + x-freighttrust-syntax: + - R0204 + - E0204 + x-freighttrust-segment-id: QTY + X12_ID_673_4: + type: string + enum: + - FL + QTY_ObstetricAnesthesiaAdditionalUnits: + required: + - AmbulancePatientCount_02 + - QuantityQualifier_01 + type: object + properties: + QuantityQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_673_4' + x-freighttrust-element-id: "673" + AmbulancePatientCount_02: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + CompositeUnitOfMeasure_03: + $ref: '#/components/schemas/C001_CompositeUnitOfMeasure' + FreeformInformation_04: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "61" + x-freighttrust-syntax: + - R0204 + - E0204 + x-freighttrust-segment-id: QTY + All_QTY_837P: + type: object + properties: + QTY_AmbulancePatientCount: + $ref: '#/components/schemas/QTY_AmbulancePatientCount' + QTY_ObstetricAnesthesiaAdditionalUnits: + $ref: '#/components/schemas/QTY_ObstetricAnesthesiaAdditionalUnits' + X12_ID_737: + type: string + enum: + - OG + - TR + X12_ID_738: + type: string + enum: + - HT + - R1 + - R2 + - R3 + - R4 + X12_ID_935: + type: string + enum: + - "01" + - "02" + - "03" + - "04" + - "05" + - "06" + - "07" + - "08" + - "09" + - "10" + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - "18" + - "19" + - "20" + - "21" + - "22" + - "23" + - "24" + - "25" + - "26" + - "27" + - "28" + - "29" + - "30" + - "31" + - "32" + - "34" + - "35" + - "36" + - "37" + - "38" + - "39" + - "40" + - "41" + - "42" + - "43" + - "44" + - "45" + - "46" + - "47" + - "49" + - "50" + - "51" + - "52" + - "53" + - "54" + - "55" + - "56" + - "57" + - "58" + - "59" + - "60" + - "61" + - "62" + - "63" + - "64" + - "65" + - "66" + - "67" + - "68" + - "69" + - "70" + - "71" + - "72" + - "73" + - "74" + - "75" + - "76" + - "77" + - "78" + - "79" + - "80" + - "81" + - "82" + - "83" + - "84" + - "85" + - "86" + - "87" + - "88" + - "89" + - "90" + - "91" + - "92" + - "93" + - "94" + - "95" + - "96" + - "97" + - "98" + - "99" + - AA + - AB + - AC + - AD + - AE + - AF + - AG + - AH + - AI + - AJ + - AK + - AL + - AM + - AN + - AO + - AP + - AQ + - AR + - AS + - AT + - AU + - AV + - AW + - AX + - AY + - AZ + - BA + - BB + - BC + - BD + - BE + - BF + - ZZ + X12_ID_936: + type: string + enum: + - "01" + - "02" + - "03" + - "04" + - "05" + - "06" + - "07" + - "08" + - "09" + - "10" + - "11" + - "12" + - "13" + - "14" + - "15" + - "16" + - "17" + - "18" + - "19" + - "20" + - "21" + - "22" + - "23" + - "24" + - "25" + - "26" + - "27" + - "28" + - "29" + - "30" + - "31" + - "32" + - "33" + - "40" + - "41" + - "42" + - "44" + - "45" + - "46" + - "48" + - "49" + - "50" + - "51" + - "52" + - "53" + - "54" + - "56" + - BA + - FL + - NA + - ND + - NS + - PR + - Q1 + - Q2 + - TA + - TB + - WS + - ZZ + X12_ID_752: + type: string + enum: + - 1S + - 2S + - A1 + - A2 + - A3 + - A4 + - A5 + - A6 + - A7 + - A8 + - A9 + - AL + - AO + - AS + - B1 + - BC + - BI + - BK + - BL + - BR + - BS + - BT + - CH + - CT + - DO + - DT + - DU + - EX + - FR + - FS + - GF + - IN + - IT + - KB + - LC + - LO + - LT + - M1 + - MC + - MD + - NS + - NT + - OA + - OS + - OT + - R0 + - R1 + - R2 + - R3 + - R4 + - R5 + - R6 + - R7 + - R8 + - R9 + - RA + - RB + - RC + - RD + - RE + - RF + - RG + - RH + - RI + - RJ + - RK + - RL + - RM + - RN + - RO + - RP + - RQ + - RR + - RS + - RT + - RU + - RV + - RW + - RX + - RY + - RZ + - S1 + - S2 + - S3 + - S4 + - S5 + - S6 + - S7 + - S8 + - S9 + - SA + - SB + - SC + - SD + - SE + - SF + - SN + - SP + - SS + - ST + - SU + - TB + - TP + - TS + - UC + - UN + - UP + - UT + - WF + X12_ID_1373: + type: string + enum: + - BM + - BO + - DM + - FT + - HN + - MA + - MM + - OM + - OU + - PT + - TM + - VA + - VB + - VC + MEA_TestResult: + required: + - MeasurementQualifier_02 + - MeasurementReferenceIdentificationCode_01 + - TestResults_03 + type: object + properties: + MeasurementReferenceIdentificationCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_737' + x-freighttrust-element-id: "737" + MeasurementQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_738' + x-freighttrust-element-id: "738" + TestResults_03: + maxLength: 20 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "739" + CompositeUnitOfMeasure_04: + $ref: '#/components/schemas/C001_CompositeUnitOfMeasure' + RangeMinimum_05: + maxLength: 20 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "740" + RangeMaximum_06: + maxLength: 20 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "741" + MeasurementSignificanceCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_935' + x-freighttrust-element-id: "935" + MeasurementAttributeCode_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_936' + x-freighttrust-element-id: "936" + SurfaceLayerPositionCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_752' + x-freighttrust-element-id: "752" + MeasurementMethodorDevice_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1373' + x-freighttrust-element-id: "1373" + CodeListQualifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1270_28' + x-freighttrust-element-id: "1270" + IndustryCode_12: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + x-freighttrust-syntax: + - R03050608 + - L050412 + - L060412 + - L07030506 + - E0803 + - P1112 + x-freighttrust-segment-id: MEA + X12_ID_128_32: + type: string + enum: + - 9B + REF_RepricedLineItemReferenceNumber: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_32' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_33: + type: string + enum: + - 9D + REF_AdjustedRepricedLineItemReferenceNumber: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_33' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_28: + type: string + enum: + - 6R + REF_LineItemControlNumber: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_28' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_41: + type: string + enum: + - F4 + REF_ReferringClinicalLaboratoryImprovementAmendment: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_41' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + X12_ID_128_42: + type: string + enum: + - BT + REF_ImmunizationBatchNumber: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_42' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + All_REF_837P_2: + type: object + properties: + REF_RepricedLineItemReferenceNumber: + $ref: '#/components/schemas/REF_RepricedLineItemReferenceNumber' + REF_AdjustedRepricedLineItemReferenceNumber: + $ref: '#/components/schemas/REF_AdjustedRepricedLineItemReferenceNumber' + REF_PriorAuthorization: + maxItems: 5 + type: array + items: + $ref: '#/components/schemas/REF_OtherPayerPriorAuthorizationNumber' + REF_LineItemControlNumber: + $ref: '#/components/schemas/REF_LineItemControlNumber' + REF_MammographyCertificationNumber: + $ref: '#/components/schemas/REF_MammographyCertificationNumber' + REF_ClinicalLaboratoryImprovementAmendment_CLIA_Number: + $ref: '#/components/schemas/REF_ClinicalLaboratoryImprovementAmendment' + REF_ReferringClinicalLaboratoryImprovementAmendment_CLIA_FacilityIdentification: + $ref: '#/components/schemas/REF_ReferringClinicalLaboratoryImprovementAmendment' + REF_ImmunizationBatchNumber: + $ref: '#/components/schemas/REF_ImmunizationBatchNumber' + REF_ReferralNumber: + maxItems: 5 + type: array + items: + $ref: '#/components/schemas/REF_OtherPayerReferralNumber' + X12_ID_522_7: + type: string + enum: + - T + AMT_SalesTaxAmount: + required: + - AmountQualifierCode_01 + - TotalClaimChargeAmount_02 + type: object + properties: + AmountQualifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_522_7' + x-freighttrust-element-id: "522" + TotalClaimChargeAmount_02: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + CreditDebitFlagCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_478' + x-freighttrust-element-id: "478" + x-freighttrust-segment-id: AMT + X12_ID_522_10: + type: string + enum: + - F4 + AMT_PostageClaimedAmount: + required: + - AmountQualifierCode_01 + - TotalClaimChargeAmount_02 + type: object + properties: + AmountQualifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_522_10' + x-freighttrust-element-id: "522" + TotalClaimChargeAmount_02: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + CreditDebitFlagCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_478' + x-freighttrust-element-id: "478" + x-freighttrust-segment-id: AMT + All_AMT_837P: + type: object + properties: + AMT_SalesTaxAmount: + $ref: '#/components/schemas/AMT_SalesTaxAmount' + AMT_PostageClaimedAmount: + $ref: '#/components/schemas/AMT_PostageClaimedAmount' + X12_ID_363_2: + type: string + enum: + - ADD + - DCP + NTE_LineNote: + required: + - BillingNoteText_02 + - NoteReferenceCode_01 + type: object + properties: + NoteReferenceCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_363_2' + x-freighttrust-element-id: "363" + BillingNoteText_02: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + x-freighttrust-segment-id: NTE + X12_ID_363_3: + type: string + enum: + - TPO + NTE_ThirdPartyOrganizationNotes: + required: + - BillingNoteText_02 + - NoteReferenceCode_01 + type: object + properties: + NoteReferenceCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_363_3' + x-freighttrust-element-id: "363" + BillingNoteText_02: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + x-freighttrust-segment-id: NTE + All_NTE_837P: + type: object + properties: + NTE_LineNote: + $ref: '#/components/schemas/NTE_LineNote' + NTE_ThirdPartyOrganizationNotes: + $ref: '#/components/schemas/NTE_ThirdPartyOrganizationNotes' + PS1_PurchasedServiceInformation: + required: + - PurchasedServiceChargeAmount_02 + - PurchasedServiceProviderIdentifier_01 + type: object + properties: + PurchasedServiceProviderIdentifier_01: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + PurchasedServiceChargeAmount_02: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + StateorProvinceCode_03: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "156" + x-freighttrust-segment-id: PS1 + X12_ID_1473: + type: string + enum: + - "00" + - "01" + - "02" + - "03" + - "04" + - "05" + - "06" + - "07" + - "08" + - "09" + - "10" + - "11" + - "12" + - "13" + - "14" + HCP_LinePricing_3: + required: + - PricingMethodology_01 + - RepricedAllowedAmount_02 + type: object + properties: + PricingMethodology_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1473' + x-freighttrust-element-id: "1473" + RepricedAllowedAmount_02: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + RepricedSavingAmount_03: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + RepricingOrganizationIdentifier_04: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + RepricingPerDiemorFlatRateAmount_05: + maxLength: 9 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "118" + RepricedApprovedAmbulatoryPatientGroupCode_06: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + MonetaryAmount_07: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + ProductServiceID_08: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235_6' + x-freighttrust-element-id: "235" + ProductServiceID_10: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + UnitorBasisforMeasurementCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355_11' + x-freighttrust-element-id: "355" + Quantity_12: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + RejectReasonCode_13: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_901_15' + x-freighttrust-element-id: "901" + PolicyComplianceCode_14: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1526' + x-freighttrust-element-id: "1526" + ExceptionCode_15: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1527' + x-freighttrust-element-id: "1527" + x-freighttrust-syntax: + - R0113 + - P0910 + - P1112 + x-freighttrust-segment-id: HCP + X12_ID_235_11: + type: string + enum: + - EN + - EO + - HI + - N4 + - "ON" + - UK + - UP + LIN_DrugIdentification_2: + required: + - NationalDrugCode_03 + - ProductorServiceIDQualifier_02 + type: object + properties: + AssignedIdentification_01: + maxLength: 20 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "350" + ProductorServiceIDQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235_11' + x-freighttrust-element-id: "235" + NationalDrugCode_03: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_05: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_07: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_09: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_11: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_12: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_13: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_14: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_15: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_16: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_17: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_18: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_19: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_20: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_21: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_22: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_23: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_24: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_25: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_26: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_27: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_28: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_29: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProductServiceIDQualifier_30: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235' + x-freighttrust-element-id: "235" + ProductServiceID_31: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + x-freighttrust-syntax: + - P0405 + - P0607 + - P0809 + - P1011 + - P1213 + - P1415 + - P1617 + - P1819 + - P2021 + - P2223 + - P2425 + - P2627 + - P2829 + - P3031 + x-freighttrust-segment-id: LIN + X12_ID_687: + type: string + enum: + - AA + - AB + - AC + - AD + - AE + - AF + - AG + - AH + - AI + - AJ + - AL + - AM + - AN + - AO + - AP + - AQ + - AR + - AS + - BG + - BR + - CB + - CN + - CO + - CR + - CX + - CY + - DE + - DF + - DI + - DR + - EX + - FS + - GA + - GM + - GR + - GV + - HS + - ID + - IN + - IR + - JB + - LC + - MC + - MF + - ML + - OE + - OF + - "ON" + - PF + - PH + - PT + - PY + - RS + - SA + - SB + - SE + - ST + - TR + - WA + - WC + - WH + - WS + X12_ID_236: + type: string + enum: + - ACT + - AGC + - ALT + - AWP + - BBP + - BCH + - BID + - C01 + - C02 + - C03 + - C04 + - C05 + - C06 + - C07 + - C08 + - C09 + - C10 + - C11 + - C12 + - C13 + - C14 + - C15 + - C16 + - C17 + - C18 + - C19 + - C20 + - C21 + - C22 + - C23 + - C24 + - C25 + - C26 + - C27 + - C28 + - C29 + - C30 + - CAN + - CAT + - CDF + - CDV + - CHG + - CON + - CUP + - CUS + - D01 + - D02 + - D03 + - DAP + - DIS + - DPR + - DSC + - DSD + - DSP + - EDM + - EDP + - EDS + - EDW + - ELC + - EST + - EUP + - FCH + - FCP + - FDS + - FET + - FGP + - FOR + - FSP + - FUL + - FUP + - GAP + - GDP + - GOV + - GSP + - GTP + - ICL + - IND + - INS + - INV + - LAR + - LCP + - LPP + - LPR + - MAP + - MAS + - MAX + - MIN + - MNC + - MNR + - MOD + - MPR + - MSR + - MXR + - N01 + - N02 + - N03 + - N04 + - N05 + - N06 + - N07 + - N08 + - N09 + - N10 + - N11 + - N12 + - N13 + - N14 + - N15 + - N16 + - N17 + - N18 + - N19 + - N20 + - N21 + - N22 + - N23 + - N24 + - N25 + - N26 + - N27 + - N28 + - N29 + - N30 + - N31 + - NET + - OAP + - OPP + - PAP + - PAQ + - PBQ + - PBR + - PHS + - PIE + - PLT + - PPA + - PPD + - PRF + - PRO + - PRP + - PUR + - QTE + - REG + - RES + - RPA + - RPM + - RPP + - RSH + - RTL + - SAC + - SDP + - SFP + - SHD + - SLP + - SPC + - SPE + - SSP + - STA + - SUM + - SWP + - THP + - TOT + - TRF + - UCP + - ULC + - WAR + - WHL + - WSP + - ZNP + X12_ID_355_6: + type: string + enum: + - F2 + - GR + - ME + - ML + - UN + C001_CompositeUnitOfMeasure_2: + required: + - UnitorBasisforMeasurementCode_01 + type: object + properties: + UnitorBasisforMeasurementCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355_6' + x-freighttrust-element-id: "355" + Exponent_02: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "1018" + Multiplier_03: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "649" + UnitorBasisforMeasurementCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355' + x-freighttrust-element-id: "355" + Exponent_05: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "1018" + Multiplier_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "649" + UnitorBasisforMeasurementCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355' + x-freighttrust-element-id: "355" + Exponent_08: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "1018" + Multiplier_09: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "649" + UnitorBasisforMeasurementCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355' + x-freighttrust-element-id: "355" + Exponent_11: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "1018" + Multiplier_12: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "649" + UnitorBasisforMeasurementCode_13: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355' + x-freighttrust-element-id: "355" + Exponent_14: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "1018" + Multiplier_15: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "649" + x-freighttrust-composite-id: C001 + X12_ID_648: + type: string + enum: + - CSD + - CSR + - DIS + - ILP + - PSP + - SEL + X12_ID_639: + type: string + enum: + - AA + - AB + - AP + - AW + - BD + - BR + - BW + - CA + - CP + - CR + - CT + - DI + - DP + - DR + - DS + - EC + - EH + - ES + - FB + - FO + - FX + - HF + - HP + - HT + - KA + - KP + - KR + - LC + - LD + - LE + - LM + - LR + - ME + - ML + - NC + - NE + - NQ + - NS + - NT + - PA + - PB + - PD + - PE + - PF + - PG + - PK + - PL + - PM + - PN + - PO + - PP + - PQ + - PR + - PS + - PT + - PU + - PV + - PY + - QE + - QH + - QR + - QS + - QT + - RC + - RD + - RE + - RM + - RS + - RT + - SA + - SC + - SM + - SR + - ST + - SW + - TB + - TC + - TD + - TE + - TF + - TM + - TP + - TT + - UM + - VQ + - WC + - WD + - WE + - WH + - WI + - WM + CTP_DrugQuantity: + required: + - CompositeUnitOfMeasure_05 + - NationalDrugUnitCount_04 + type: object + properties: + ClassofTradeCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_687' + x-freighttrust-element-id: "687" + PriceIdentifierCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_236' + x-freighttrust-element-id: "236" + UnitPrice_03: + maxLength: 17 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "212" + NationalDrugUnitCount_04: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + CompositeUnitOfMeasure_05: + $ref: '#/components/schemas/C001_CompositeUnitOfMeasure_2' + PriceMultiplierQualifier_06: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_648' + x-freighttrust-element-id: "648" + Multiplier_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "649" + MonetaryAmount_08: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + BasisofUnitPriceCode_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_639' + x-freighttrust-element-id: "639" + ConditionValue_10: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "499" + MultiplePriceQuantity_11: + maxLength: 2 + minLength: 1 + type: string + format: X12_N0 + x-freighttrust-element-id: "289" + x-freighttrust-syntax: + - P0405 + - C0607 + - C0902 + - C1002 + - C1103 + x-freighttrust-segment-id: CTP + X12_ID_128_34: + type: string + enum: + - VY + - XZ + REF_PrescriptionorCompoundDrugAssociationNumber: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_34' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + Loop_2410_837P: + required: + - CTP_DrugQuantity + - LIN_DrugIdentification + type: object + properties: + LIN_DrugIdentification: + $ref: '#/components/schemas/LIN_DrugIdentification_2' + CTP_DrugQuantity: + $ref: '#/components/schemas/CTP_DrugQuantity' + REF_PrescriptionorCompoundDrugAssociationNumber: + $ref: '#/components/schemas/REF_PrescriptionorCompoundDrugAssociationNumber' + x-freighttrust-loop-id: "2410" + Loop_2420A_837P: + required: + - NM1_RenderingProviderName + type: object + properties: + NM1_RenderingProviderName: + $ref: '#/components/schemas/NM1_RenderingProviderName' + PRV_RenderingProviderSpecialtyInformation: + $ref: '#/components/schemas/PRV_RenderingProviderSpecialtyInformation' + REF_RenderingProviderSecondaryIdentification: + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/REF_AssistantSurgeonSecondaryIdentification' + x-freighttrust-loop-id: 2420A + X12_ID_98_16: + type: string + enum: + - QB + NM1_PurchasedServiceProviderName: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_16' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065_2' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_7' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + Loop_2420B_837P: + required: + - NM1_PurchasedServiceProviderName + type: object + properties: + NM1_PurchasedServiceProviderName: + $ref: '#/components/schemas/NM1_PurchasedServiceProviderName' + REF_PurchasedServiceProviderSecondaryIdentification: + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/REF_OrderingProviderSecondaryIdentification' + x-freighttrust-loop-id: 2420B + Loop_2420C_837P: + required: + - N3_ServiceFacilityLocationAddress + - N4_ServiceFacilityLocationCity_State_ZIPCode + - NM1_ServiceFacilityLocation + type: object + properties: + NM1_ServiceFacilityLocation: + $ref: '#/components/schemas/NM1_ServiceFacilityLocation' + N3_ServiceFacilityLocationAddress: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_ServiceFacilityLocationCity_State_ZIPCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + REF_ServiceFacilityLocationSecondaryIdentification: + maxItems: 3 + type: array + items: + $ref: '#/components/schemas/REF_BillingProviderSecondaryIdentification' + x-freighttrust-loop-id: 2420C + Loop_2420D_837P: + required: + - NM1_SupervisingProviderName + type: object + properties: + NM1_SupervisingProviderName: + $ref: '#/components/schemas/NM1_SupervisingProviderName' + REF_SupervisingProviderSecondaryIdentification: + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/REF_AssistantSurgeonSecondaryIdentification' + x-freighttrust-loop-id: 2420D + X12_ID_98_18: + type: string + enum: + - DK + NM1_OrderingProviderName: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + - ResponseContactLastorOrganizationName_03 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_18' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_7' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + Loop_2420E_837P: + required: + - NM1_OrderingProviderName + type: object + properties: + NM1_OrderingProviderName: + $ref: '#/components/schemas/NM1_OrderingProviderName' + N3_OrderingProviderAddress: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_OrderingProviderCity_State_ZIPCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + REF_OrderingProviderSecondaryIdentification: + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/REF_OrderingProviderSecondaryIdentification' + PER_OrderingProviderContactInformation: + $ref: '#/components/schemas/PER_BillingProviderContactInformation' + x-freighttrust-loop-id: 2420E + Loop_2420F_837P: + required: + - NM1_ReferringProviderName + type: object + properties: + NM1_ReferringProviderName: + $ref: '#/components/schemas/NM1_ReferringProviderName' + REF_ReferringProviderSecondaryIdentification: + maxItems: 20 + type: array + items: + $ref: '#/components/schemas/REF_OrderingProviderSecondaryIdentification' + x-freighttrust-loop-id: 2420F + Loop_2420G_837P: + required: + - N3_AmbulancePick_LocationAddress + - N4_AmbulancePick_LocationCity_State_ZipCode + - NM1_AmbulancePick_Location + type: object + properties: + NM1_AmbulancePick_Location: + $ref: '#/components/schemas/NM1_AmbulancePick' + N3_AmbulancePick_LocationAddress: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_AmbulancePick_LocationCity_State_ZipCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + x-freighttrust-loop-id: 2420G + Loop_2420H_837P: + required: + - N3_AmbulanceDrop_LocationAddress + - N4_AmbulanceDrop_LocationCity_State_ZipCode + - NM1_AmbulanceDrop_Location + type: object + properties: + NM1_AmbulanceDrop_Location: + $ref: '#/components/schemas/NM1_AmbulanceDrop' + N3_AmbulanceDrop_LocationAddress: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_AmbulanceDrop_LocationCity_State_ZipCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + x-freighttrust-loop-id: 2420H + All_NM1_837P_5: + type: object + properties: + Loop2420A: + $ref: '#/components/schemas/Loop_2420A_837P' + Loop2420B: + $ref: '#/components/schemas/Loop_2420B_837P' + Loop2420C: + $ref: '#/components/schemas/Loop_2420C_837P' + Loop2420D: + $ref: '#/components/schemas/Loop_2420D_837P' + Loop2420E: + $ref: '#/components/schemas/Loop_2420E_837P' + Loop2420F: + maxItems: 2 + type: array + items: + $ref: '#/components/schemas/Loop_2420F_837P' + Loop2420G: + $ref: '#/components/schemas/Loop_2420G_837P' + Loop2420H: + $ref: '#/components/schemas/Loop_2420H_837P' + X12_ID_235_8: + type: string + enum: + - AD + - ER + C003_CompositeMedicalProcedureIdentifier_7: + required: + - ProcedureCode_02 + - ProductorServiceIDQualifier_01 + type: object + properties: + ProductorServiceIDQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_235_8' + x-freighttrust-element-id: "235" + ProcedureCode_02: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + ProcedureModifier_03: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "1339" + ProcedureModifier_04: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "1339" + ProcedureModifier_05: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "1339" + ProcedureModifier_06: + maxLength: 2 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "1339" + Description_07: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ProductServiceID_08: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + x-freighttrust-composite-id: C003 + SVD_LineAdjudicationInformation: + required: + - CompositeMedicalProcedureIdentifier_03 + - OtherPayerPrimaryIdentifier_01 + - PaidServiceUnitCount_05 + - ServiceLinePaidAmount_02 + type: object + properties: + OtherPayerPrimaryIdentifier_01: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + ServiceLinePaidAmount_02: + maxLength: 18 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "782" + CompositeMedicalProcedureIdentifier_03: + $ref: '#/components/schemas/C003_CompositeMedicalProcedureIdentifier_7' + ProductServiceID_04: + maxLength: 48 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "234" + PaidServiceUnitCount_05: + maxLength: 15 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "380" + BundledorUnbundledLineNumber_06: + maxLength: 6 + minLength: 1 + type: string + format: X12_N0 + x-freighttrust-element-id: "554" + x-freighttrust-segment-id: SVD + Loop_2430_837P: + required: + - DTP_LineCheckorRemittanceDate + - SVD_LineAdjudicationInformation + type: object + properties: + SVD_LineAdjudicationInformation: + $ref: '#/components/schemas/SVD_LineAdjudicationInformation' + CAS_LineAdjustment: + maxItems: 5 + type: array + items: + $ref: '#/components/schemas/CAS_ClaimLevelAdjustments' + DTP_LineCheckorRemittanceDate: + $ref: '#/components/schemas/DTP_ClaimCheckOrRemittanceDate' + AMT_RemainingPatientLiability: + $ref: '#/components/schemas/AMT_RemainingPatientLiability' + x-freighttrust-loop-id: "2430" + X12_ID_1270_25: + type: string + enum: + - AS + - UT + LQ_FormIdentificationCode: + required: + - CodeListQualifierCode_01 + - FormIdentifier_02 + type: object + properties: + CodeListQualifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1270_25' + x-freighttrust-element-id: "1270" + FormIdentifier_02: + maxLength: 30 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1271" + x-freighttrust-syntax: + - C0102 + x-freighttrust-segment-id: LQ + FRM_SupportingDocumentation: + required: + - QuestionNumberLetter_01 + type: object + properties: + QuestionNumberLetter_01: + maxLength: 20 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "350" + QuestionResponse_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073_5' + x-freighttrust-element-id: "1073" + QuestionResponse_03: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + QuestionResponse_04: + maxLength: 8 + minLength: 8 + type: string + format: X12_DT + x-freighttrust-element-id: "373" + QuestionResponse_05: + maxLength: 6 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "332" + x-freighttrust-syntax: + - R02030405 + x-freighttrust-segment-id: FRM + Loop_2440_837P: + required: + - FRM_SupportingDocumentation + - LQ_FormIdentificationCode + type: object + properties: + LQ_FormIdentificationCode: + $ref: '#/components/schemas/LQ_FormIdentificationCode' + FRM_SupportingDocumentation: + maxItems: 99 + type: array + items: + $ref: '#/components/schemas/FRM_SupportingDocumentation' + x-freighttrust-loop-id: "2440" + Loop_2400_837P: + required: + - AllDTP + - LX_ServiceLineNumber + - SV1_ProfessionalService + type: object + properties: + LX_ServiceLineNumber: + $ref: '#/components/schemas/LX_HeaderNumber' + SV1_ProfessionalService: + $ref: '#/components/schemas/SV1_ProfessionalService' + SV5_DurableMedicalEquipmentService: + $ref: '#/components/schemas/SV5_DurableMedicalEquipmentService' + AllPWK: + $ref: '#/components/schemas/All_PWK_837P' + CR1_AmbulanceTransportInformation: + $ref: '#/components/schemas/CR1_AmbulanceTransportInformation' + CR3_DurableMedicalEquipmentCertification: + $ref: '#/components/schemas/CR3_DurableMedicalEquipmentCertification' + AllCRC: + $ref: '#/components/schemas/All_CRC_837P' + AllDTP: + $ref: '#/components/schemas/All_DTP_837P' + AllQTY: + $ref: '#/components/schemas/All_QTY_837P' + MEA_TestResult: + maxItems: 5 + type: array + items: + $ref: '#/components/schemas/MEA_TestResult' + CN1_ContractInformation: + $ref: '#/components/schemas/CN1_ContractInformation_2' + AllREF: + $ref: '#/components/schemas/All_REF_837P_2' + AllAMT: + $ref: '#/components/schemas/All_AMT_837P' + K3_FileInformation: + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/K3_FileInformation' + AllNTE: + $ref: '#/components/schemas/All_NTE_837P' + PS1_PurchasedServiceInformation: + $ref: '#/components/schemas/PS1_PurchasedServiceInformation' + HCP_LinePricing_RepricingInformation: + $ref: '#/components/schemas/HCP_LinePricing_3' + Loop2410: + $ref: '#/components/schemas/Loop_2410_837P' + AllNM1: + $ref: '#/components/schemas/All_NM1_837P_5' + Loop2430: + maxItems: 15 + type: array + items: + $ref: '#/components/schemas/Loop_2430_837P' + Loop2440: + type: array + items: + $ref: '#/components/schemas/Loop_2440_837P' + x-freighttrust-loop-id: "2400" + Loop_2300_837P: + required: + - AllHI + - CLM_ClaimInformation + - Loop2400 + type: object + properties: + CLM_ClaimInformation: + $ref: '#/components/schemas/CLM_ClaimInformation_3' + AllDTP: + $ref: '#/components/schemas/All_DTP_837P_2' + PWK_ClaimSupplementalInformation: + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/PWK_ClaimSupplementalInformation_3' + CN1_ContractInformation: + $ref: '#/components/schemas/CN1_ContractInformation_2' + AMT_PatientAmountPaid: + $ref: '#/components/schemas/AMT_PatientAmountPaid' + AllREF: + $ref: '#/components/schemas/All_REF_837P_6' + K3_FileInformation: + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/K3_FileInformation' + NTE_ClaimNote: + $ref: '#/components/schemas/NTE_ClaimNote_2' + CR1_AmbulanceTransportInformation: + $ref: '#/components/schemas/CR1_AmbulanceTransportInformation' + CR2_SpinalManipulationServiceInformation: + $ref: '#/components/schemas/CR2_SpinalManipulationServiceInformation' + AllCRC: + $ref: '#/components/schemas/All_CRC_837P_2' + AllHI: + $ref: '#/components/schemas/All_HI_837P' + HCP_ClaimPricing_RepricingInformation: + $ref: '#/components/schemas/HCP_ClaimPricing' + AllNM1: + $ref: '#/components/schemas/All_NM1_837P_3' + Loop2320: + maxItems: 10 + type: array + items: + $ref: '#/components/schemas/Loop_2320_837P' + Loop2400: + maxItems: 50 + type: array + items: + $ref: '#/components/schemas/Loop_2400_837P' + x-freighttrust-loop-id: "2300" + X12_ID_735_4: + type: string + enum: + - "23" + X12_ID_736_2: + type: string + enum: + - "0" + HL_DependentLevel: + required: + - HierarchicalChildCode_04 + - HierarchicalIDNumber_01 + - HierarchicalLevelCode_03 + - HierarchicalParentIDNumber_02 + type: object + properties: + HierarchicalIDNumber_01: + maxLength: 12 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "628" + HierarchicalParentIDNumber_02: + maxLength: 12 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "734" + HierarchicalLevelCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_735_4' + x-freighttrust-element-id: "735" + HierarchicalChildCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_736_2' + x-freighttrust-element-id: "736" + x-freighttrust-segment-id: HL + X12_ID_1069_2: + type: string + enum: + - "01" + - "19" + - "20" + - "21" + - "39" + - "40" + - "53" + - G8 + PAT_PatientInformation: + required: + - IndividualRelationshipCode_01 + type: object + properties: + IndividualRelationshipCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1069_2' + x-freighttrust-element-id: "1069" + PatientLocationCode_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1384' + x-freighttrust-element-id: "1384" + EmploymentStatusCode_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_584_2' + x-freighttrust-element-id: "584" + StudentStatusCode_04: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1220' + x-freighttrust-element-id: "1220" + DateTimePeriodFormatQualifier_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1250_6' + x-freighttrust-element-id: "1250" + PatientDeathDate_06: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1251" + UnitorBasisforMeasurementCode_07: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_355_16' + x-freighttrust-element-id: "355" + PatientWeight_08: + maxLength: 10 + minLength: 1 + type: string + format: X12_R + x-freighttrust-element-id: "81" + PregnancyIndicator_09: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1073' + x-freighttrust-element-id: "1073" + x-freighttrust-syntax: + - P0506 + - P0708 + x-freighttrust-segment-id: PAT + X12_ID_98_13: + type: string + enum: + - QC + NM1_PatientName_3: + required: + - EntityIdentifierCode_01 + - EntityTypeQualifier_02 + - ResponseContactLastorOrganizationName_03 + type: object + properties: + EntityIdentifierCode_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_13' + x-freighttrust-element-id: "98" + EntityTypeQualifier_02: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_1065' + x-freighttrust-element-id: "1065" + ResponseContactLastorOrganizationName_03: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + ResponseContactFirstName_04: + maxLength: 35 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1036" + ResponseContactMiddleName_05: + maxLength: 25 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1037" + NamePrefix_06: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1038" + ResponseContactNameSuffix_07: + maxLength: 10 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1039" + IdentificationCodeQualifier_08: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_66_12' + x-freighttrust-element-id: "66" + ResponseContactIdentifier_09: + maxLength: 80 + minLength: 2 + type: string + format: X12_AN + x-freighttrust-element-id: "67" + EntityRelationshipCode_10: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_706_3' + x-freighttrust-element-id: "706" + EntityIdentifierCode_11: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_98_19' + x-freighttrust-element-id: "98" + NameLastorOrganizationName_12: + maxLength: 60 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "1035" + x-freighttrust-syntax: + - P0809 + - C1110 + - C1203 + x-freighttrust-segment-id: NM1 + X12_ID_128_31: + type: string + enum: + - 1W + - SY + C040_ReferenceIdentifier_7: + required: + - ReferenceIdentificationQualifier_01 + - ReferenceIdentificationQualifier_03 + - ReferenceIdentificationQualifier_05 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_20' + x-freighttrust-element-id: "128" + ReferenceIdentification_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + ReferenceIdentificationQualifier_03: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_20' + x-freighttrust-element-id: "128" + ReferenceIdentification_04: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + ReferenceIdentificationQualifier_05: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_20' + x-freighttrust-element-id: "128" + ReferenceIdentification_06: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + x-freighttrust-composite-id: C040 + REF_PropertyandCasualtyPatientIdentifier: + required: + - MemberGrouporPolicyNumber_02 + - ReferenceIdentificationQualifier_01 + type: object + properties: + ReferenceIdentificationQualifier_01: + type: string + allOf: + - $ref: '#/components/schemas/X12_ID_128_31' + x-freighttrust-element-id: "128" + MemberGrouporPolicyNumber_02: + maxLength: 50 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "127" + Description_03: + maxLength: 80 + minLength: 1 + type: string + format: X12_AN + x-freighttrust-element-id: "352" + ReferenceIdentifier_04: + $ref: '#/components/schemas/C040_ReferenceIdentifier_7' + x-freighttrust-syntax: + - R0203 + x-freighttrust-segment-id: REF + All_REF_837P_7: + type: object + properties: + REF_PropertyandCasualtyClaimNumber: + $ref: '#/components/schemas/REF_PropertyandCasualtyClaimNumber' + REF_PropertyandCasualtyPatientIdentifier: + $ref: '#/components/schemas/REF_PropertyandCasualtyPatientIdentifier' + Loop_2010CA_837P: + required: + - DMG_PatientDemographicInformation + - N3_PatientAddress + - N4_PatientCity_State_ZIPCode + - NM1_PatientName + type: object + properties: + NM1_PatientName: + $ref: '#/components/schemas/NM1_PatientName_3' + N3_PatientAddress: + $ref: '#/components/schemas/N3_AdditionalPatientInformationContactAddress' + N4_PatientCity_State_ZIPCode: + $ref: '#/components/schemas/N4_AdditionalPatientInformationContactCity' + DMG_PatientDemographicInformation: + $ref: '#/components/schemas/DMG_PatientDemographicInformation' + AllREF: + $ref: '#/components/schemas/All_REF_837P_7' + PER_PropertyandCasualtyPatientContactInformation: + $ref: '#/components/schemas/PER_PropertyandCasualtyPatientContactInformation' + x-freighttrust-loop-id: 2010CA + Loop_2000C_837P: + required: + - HL_PatientHierarchicalLevel + - Loop2010CA + - Loop2300 + - PAT_PatientInformation + type: object + properties: + HL_PatientHierarchicalLevel: + $ref: '#/components/schemas/HL_DependentLevel' + PAT_PatientInformation: + $ref: '#/components/schemas/PAT_PatientInformation' + Loop2010CA: + $ref: '#/components/schemas/Loop_2010CA_837P' + Loop2300: + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/Loop_2300_837P' + x-freighttrust-loop-id: 2000C + Loop_2000B_837P: + required: + - AllNM1 + - HL_SubscriberHierarchicalLevel + - SBR_SubscriberInformation + type: object + properties: + HL_SubscriberHierarchicalLevel: + $ref: '#/components/schemas/HL_SubscriberHierarchicalLevel' + SBR_SubscriberInformation: + $ref: '#/components/schemas/SBR_SubscriberInformation' + PAT_PatientInformation: + $ref: '#/components/schemas/PAT_PatientInformation_3' + AllNM1: + $ref: '#/components/schemas/All_NM1_837P_2' + Loop2300: + maxItems: 100 + type: array + items: + $ref: '#/components/schemas/Loop_2300_837P' + Loop2000C: + type: array + items: + $ref: '#/components/schemas/Loop_2000C_837P' + x-freighttrust-loop-id: 2000B + Loop_2000A_837P: + required: + - AllNM1 + - HL_BillingProviderHierarchicalLevel + - Loop2000B + type: object + properties: + HL_BillingProviderHierarchicalLevel: + $ref: '#/components/schemas/HL_BillingProviderHierarchicalLevel' + PRV_BillingProviderSpecialtyInformation: + $ref: '#/components/schemas/PRV_BillingProviderSpecialtyInformation' + CUR_ForeignCurrencyInformation: + $ref: '#/components/schemas/CUR_ForeignCurrencyInformation_3' + AllNM1: + $ref: '#/components/schemas/All_NM1_837P' + Loop2000B: + type: array + items: + $ref: '#/components/schemas/Loop_2000B_837P' + x-freighttrust-loop-id: 2000A + SE: + required: + - NumberofIncludedSegments_01 + - TransactionSetControlNumber_02 + type: object + properties: + NumberofIncludedSegments_01: + maxLength: 10 + minLength: 1 + type: string + format: X12_N0 + x-freighttrust-element-id: "96" + TransactionSetControlNumber_02: + maxLength: 9 + minLength: 4 + type: string + format: X12_AN + x-freighttrust-element-id: "329" + x-freighttrust-segment-id: SE + securitySchemes: + ApiKey: + type: apiKey + description: API key to authenticate requests + name: Ocp-Apim-Subscription-Key + in: header + x-apikeyInfoFunc: swagger_server.controllers.authorization_controller.check_ApiKey + diff --git a/git_push.sh b/git_push.sh new file mode 100644 index 0000000..ae01b18 --- /dev/null +++ b/git_push.sh @@ -0,0 +1,52 @@ +#!/bin/sh +# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/ +# +# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update" + +git_user_id=$1 +git_repo_id=$2 +release_note=$3 + +if [ "$git_user_id" = "" ]; then + git_user_id="GIT_USER_ID" + echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id" +fi + +if [ "$git_repo_id" = "" ]; then + git_repo_id="GIT_REPO_ID" + echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id" +fi + +if [ "$release_note" = "" ]; then + release_note="Minor update" + echo "[INFO] No command line input provided. Set \$release_note to $release_note" +fi + +# Initialize the local directory as a Git repository +git init + +# Adds the files in the local repository and stages them for commit. +git add . + +# Commits the tracked changes and prepares them to be pushed to a remote repository. +git commit -m "$release_note" + +# Sets the new remote +git_remote=`git remote` +if [ "$git_remote" = "" ]; then # git remote not defined + + if [ "$GIT_TOKEN" = "" ]; then + echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment." + git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git + else + git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git + fi + +fi + +git pull origin master + +# Pushes (Forces) the changes in the local repository up to the remote repository +echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git" +git push origin master 2>&1 | grep -v 'To https' + diff --git a/lei-jsonld.json b/lei-jsonld.json new file mode 100644 index 0000000..f8b075c --- /dev/null +++ b/lei-jsonld.json @@ -0,0 +1,1770 @@ +[ { + "@id" : "_:genid1", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#minQualifiedCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "0" + } ], + "http://www.w3.org/2002/07/owl#onClass" : [ { + "@id" : "https://www.omg.org/spec/LCC/Countries/CountryRepresentation/GeographicRegion" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasLegalJurisdiction" + } ] +}, { + "@id" : "_:genid11", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2002/07/owl#oneOf" : [ { + "@list" : [ { + "@id" : "https://www.gleif.org/ontology/Base/EntityStatusActive" + }, { + "@id" : "https://www.gleif.org/ontology/Base/EntityStatusInactive" + } ] + } ] +}, { + "@id" : "_:genid14", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#cardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/identifies" + } ] +}, { + "@id" : "_:genid15", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#onDataRange" : [ { + "@id" : "http://www.w3.org/2001/XMLSchema#string" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasTag" + } ], + "http://www.w3.org/2002/07/owl#qualifiedCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ] +}, { + "@id" : "_:genid16", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#onClass" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasSource" + } ], + "http://www.w3.org/2002/07/owl#qualifiedCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ] +}, { + "@id" : "_:genid17", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#onClass" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasTarget" + } ], + "http://www.w3.org/2002/07/owl#qualifiedCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ] +}, { + "@id" : "_:genid18", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#onDataRange" : [ { + "@id" : "http://www.w3.org/2001/XMLSchema#dateTime" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasStart" + } ], + "http://www.w3.org/2002/07/owl#qualifiedCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ] +}, { + "@id" : "_:genid19", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#maxQualifiedCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onDataRange" : [ { + "@id" : "http://www.w3.org/2001/XMLSchema#dateTime" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasEnd" + } ] +}, { + "@id" : "_:genid2", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#minQualifiedCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "0" + } ], + "http://www.w3.org/2002/07/owl#onClass" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasSuccessor" + } ] +}, { + "@id" : "_:genid20", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#onClass" : [ { + "@id" : "https://www.omg.org/spec/LCC/Countries/CountryRepresentation/Country" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasCountry" + } ], + "http://www.w3.org/2002/07/owl#qualifiedCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ] +}, { + "@id" : "_:genid21", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#maxQualifiedCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onClass" : [ { + "@id" : "https://www.omg.org/spec/LCC/Countries/CountryRepresentation/Region" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasRegion" + } ] +}, { + "@id" : "_:genid22", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#cardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressLine1" + } ] +}, { + "@id" : "_:genid23", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#cardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasCity" + } ] +}, { + "@id" : "_:genid24", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#maxCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressLine2" + } ] +}, { + "@id" : "_:genid25", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#maxCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressLine3" + } ] +}, { + "@id" : "_:genid26", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#maxCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressLine4" + } ] +}, { + "@id" : "_:genid27", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#maxCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressNumber" + } ] +}, { + "@id" : "_:genid28", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#maxCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressNumberWithinBuilding" + } ] +}, { + "@id" : "_:genid29", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#maxCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasMailRouting" + } ] +}, { + "@id" : "_:genid3", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#onClass" : [ { + "@id" : "https://www.gleif.org/ontology/Base/EntityStatus" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasEntityStatus" + } ], + "http://www.w3.org/2002/07/owl#qualifiedCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ] +}, { + "@id" : "_:genid30", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#maxCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasPostalCode" + } ] +}, { + "@id" : "_:genid31", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#onClass" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/isManagedBy" + } ], + "http://www.w3.org/2002/07/owl#qualifiedCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ] +}, { + "@id" : "_:genid32", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/isRegisteredIn" + } ], + "http://www.w3.org/2002/07/owl#someValuesFrom" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Registry" + } ] +}, { + "@id" : "_:genid33", + "@type" : [ "http://www.w3.org/2002/07/owl#AllDifferent" ], + "http://www.w3.org/2002/07/owl#distinctMembers" : [ { + "@list" : [ { + "@id" : "https://www.gleif.org/ontology/Base/EntityExpirationReasonCorporateAction" + }, { + "@id" : "https://www.gleif.org/ontology/Base/EntityExpirationReasonDissolved" + }, { + "@id" : "https://www.gleif.org/ontology/Base/EntityExpirationReasonOther" + } ] + } ] +}, { + "@id" : "_:genid37", + "@type" : [ "http://www.w3.org/2002/07/owl#AllDifferent" ], + "http://www.w3.org/2002/07/owl#distinctMembers" : [ { + "@list" : [ { + "@id" : "https://www.gleif.org/ontology/Base/EntityStatusActive" + }, { + "@id" : "https://www.gleif.org/ontology/Base/EntityStatusInactive" + } ] + } ] +}, { + "@id" : "_:genid4", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#maxQualifiedCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onClass" : [ { + "@id" : "https://www.gleif.org/ontology/Base/EntityExpirationReason" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasEntityExpirationReason" + } ] +}, { + "@id" : "_:genid5", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#cardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasNameLegalLocal" + } ] +}, { + "@id" : "_:genid6", + "@type" : [ "http://www.w3.org/2002/07/owl#Restriction" ], + "http://www.w3.org/2002/07/owl#maxQualifiedCardinality" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#nonNegativeInteger", + "@value" : "1" + } ], + "http://www.w3.org/2002/07/owl#onDataRange" : [ { + "@id" : "http://www.w3.org/2001/XMLSchema#dateTime" + } ], + "http://www.w3.org/2002/07/owl#onProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasEntityExpirationDate" + } ] +}, { + "@id" : "_:genid7", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2002/07/owl#oneOf" : [ { + "@list" : [ { + "@id" : "https://www.gleif.org/ontology/Base/EntityExpirationReasonCorporateAction" + }, { + "@id" : "https://www.gleif.org/ontology/Base/EntityExpirationReasonDissolved" + }, { + "@id" : "https://www.gleif.org/ontology/Base/EntityExpirationReasonOther" + } ] + } ] +}, { + "@id" : "http://purl.org/dc/terms/created", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ] +}, { + "@id" : "http://purl.org/dc/terms/modified", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ] +}, { + "@id" : "http://purl.org/dc/terms/rightsHolder", + "@type" : [ "http://www.w3.org/2002/07/owl#AnnotationProperty" ] +}, { + "@id" : "http://purl.org/vocab/vann/preferredNamespacePrefix", + "@type" : [ "http://www.w3.org/2002/07/owl#AnnotationProperty" ] +}, { + "@id" : "http://purl.org/vocab/vann/preferredNamespaceUri", + "@type" : [ "http://www.w3.org/2002/07/owl#AnnotationProperty" ] +}, { + "@id" : "http://purl.org/vocommons/voaf#Vocabulary", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/", + "@type" : [ "http://www.w3.org/2002/07/owl#Ontology", "http://www.w3.org/2002/07/owl#NamedIndividual", "http://purl.org/vocommons/voaf#Vocabulary" ], + "http://purl.org/dc/terms/abstract" : [ { + "@language" : "en", + "@value" : "Ontology defining generic concepts for reuse by other Global Legal Entity Identifier Foundation (GLEIF) ontologies. It defines generic classes for (legal) Entities and their relationships and statuses; and generic properties for different types of name and address. It makes use of the OMG Languages Countries and Codes (LCC) ontology (based on the ISO 3166 standard) for country and region information." + } ], + "http://purl.org/dc/terms/contributor" : [ { + "@id" : "http://www.workingontologist.com" + }, { + "@id" : "http://purl.org/bryon" + }, { + "@id" : "https://www.linkedin.com/in/peterivett/" + } ], + "http://purl.org/dc/terms/creator" : [ { + "@id" : "https://www.gleif.org/ontology/Base/GLEIF" + } ], + "http://purl.org/dc/terms/issued" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#dateTime", + "@value" : "2019-02-01T00:00:00+00:00" + } ], + "http://purl.org/dc/terms/license" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#anyURI", + "@value" : "https://www.gleif.org/en/meta/lei-data-terms-of-use/" + } ], + "http://purl.org/dc/terms/rights" : [ { + "@value" : "Copyright (c) 2019 Global Legal Entity Identifier Foundation (GLEIF)" + } ], + "http://purl.org/dc/terms/rightsHolder" : [ { + "@id" : "https://www.gleif.org/ontology/Base/GLEIF" + } ], + "http://purl.org/dc/terms/source" : [ { + "@type" : "http://www.w3.org/2001/XMLSchema#anyURI", + "@value" : "https://www.gleif.org/en/about-lei/common-data-file-format/lei-cdf-format/lei-cdf-format-version-2-1" + } ], + "http://purl.org/dc/terms/title" : [ { + "@language" : "en", + "@value" : "Global Legal Entity Identifier Foundation Base Ontology" + } ], + "http://purl.org/vocab/vann/preferredNamespacePrefix" : [ { + "@value" : "gleif-base" + } ], + "http://purl.org/vocab/vann/preferredNamespaceUri" : [ { + "@value" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@language" : "en", + "@value" : "GLEIF Base Ontology" + } ], + "http://www.w3.org/2002/07/owl#imports" : [ { + "@id" : "https://www.omg.org/spec/LCC/Countries/CountryRepresentation/" + } ], + "http://www.w3.org/2002/07/owl#versionIRI" : [ { + "@id" : "https://www.gleif.org/ontology/Base-v1.0/Base/" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/Entity", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "entity" + } ], + "http://www.w3.org/2000/01/rdf-schema#subClassOf" : [ { + "@id" : "_:genid1" + }, { + "@id" : "_:genid2" + }, { + "@id" : "_:genid3" + }, { + "@id" : "_:genid4" + }, { + "@id" : "_:genid5" + }, { + "@id" : "_:genid6" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "A partnership, corporation, or other organization having the capacity to negotiate contracts, assume financial obligations, and pay off debts, organized under the laws of some jurisdiction." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/EntityExpirationReason", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "entity expiration reason" + } ], + "http://www.w3.org/2002/07/owl#equivalentClass" : [ { + "@id" : "_:genid7" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The reason that an entity ceased to exist and/or operate." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/EntityExpirationReasonCorporateAction", + "@type" : [ "http://www.w3.org/2002/07/owl#NamedIndividual", "https://www.gleif.org/ontology/Base/EntityExpirationReason" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "corporate action" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The entity was acquired or merged with another entity." + } ], + "https://www.gleif.org/ontology/Base/hasTag" : [ { + "@value" : "CORPORATE_ACTION" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/EntityExpirationReasonDissolved", + "@type" : [ "http://www.w3.org/2002/07/owl#NamedIndividual", "https://www.gleif.org/ontology/Base/EntityExpirationReason" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "dissolved" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The entity ceased to operate." + } ], + "https://www.gleif.org/ontology/Base/hasTag" : [ { + "@value" : "DISSOLVED" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/EntityExpirationReasonOther", + "@type" : [ "http://www.w3.org/2002/07/owl#NamedIndividual", "https://www.gleif.org/ontology/Base/EntityExpirationReason" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "other" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The reason for expiry is neither of dissolved nor corporate action." + } ], + "https://www.gleif.org/ontology/Base/hasTag" : [ { + "@value" : "OTHER" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/EntityStatus", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "entity status" + } ], + "http://www.w3.org/2002/07/owl#equivalentClass" : [ { + "@id" : "_:genid11" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The operational and/or legal registration status of the entity (may be ACTIVE or INACTIVE)" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/EntityStatusActive", + "@type" : [ "http://www.w3.org/2002/07/owl#NamedIndividual", "https://www.gleif.org/ontology/Base/EntityStatus" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "active" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "As of the last report or update, the entity reported that it was legally registered and operating." + } ], + "https://www.gleif.org/ontology/Base/hasTag" : [ { + "@value" : "ACTIVE" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/EntityStatusInactive", + "@type" : [ "http://www.w3.org/2002/07/owl#NamedIndividual", "https://www.gleif.org/ontology/Base/EntityStatus" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "inactive" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "It has been determined that the entity that was assigned the LEI is no longer legally registered and/or operating, whether as a result of business closure, acquisition by or merger with another (or new) entity, or determination of illegitimacy." + } ], + "https://www.gleif.org/ontology/Base/hasTag" : [ { + "@value" : "INACTIVE" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/GLEIF", + "@type" : [ "http://www.w3.org/2002/07/owl#NamedIndividual", "https://www.gleif.org/ontology/Base/RegistrationAuthority" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "https://www.gleif.org/ontology/Base/hasLegalName" : [ { + "@value" : "Global Legal Entity Identifier Foundation" + } ], + "https://www.gleif.org/ontology/Base/hasNameLegalLocal" : [ { + "@language" : "en", + "@value" : "Global Legal Entity Identifier Foundation" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/Identifier", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "identifier" + } ], + "http://www.w3.org/2000/01/rdf-schema#subClassOf" : [ { + "@id" : "_:genid14" + }, { + "@id" : "_:genid15" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Sequence of characters, capable of uniquely identifying that with which it is associated, within a specified context." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/LegalEntityRelationship", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "legal entity relationship" + } ], + "http://www.w3.org/2000/01/rdf-schema#subClassOf" : [ { + "@id" : "_:genid16" + }, { + "@id" : "_:genid17" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "abstract superclass to represent a reified directed relationship" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/LegalPerson", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "legal person" + } ], + "http://www.w3.org/2000/01/rdf-schema#subClassOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Any entity which can incur legal obligation and can be sued at law." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/Period", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@language" : "en", + "@value" : "period" + } ], + "http://www.w3.org/2000/01/rdf-schema#subClassOf" : [ { + "@id" : "_:genid18" + }, { + "@id" : "_:genid19" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "A period of time, with at least a start time, and possibly an end." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@language" : "en", + "@value" : "physical address" + } ], + "http://www.w3.org/2000/01/rdf-schema#subClassOf" : [ { + "@id" : "_:genid20" + }, { + "@id" : "_:genid21" + }, { + "@id" : "_:genid22" + }, { + "@id" : "_:genid23" + }, { + "@id" : "_:genid24" + }, { + "@id" : "_:genid25" + }, { + "@id" : "_:genid26" + }, { + "@id" : "_:genid27" + }, { + "@id" : "_:genid28" + }, { + "@id" : "_:genid29" + }, { + "@id" : "_:genid30" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "a physical address where communications can be addressed, papers served or representatives located for any kind of organization or person" + } ], + "http://www.w3.org/2004/02/skos/core#note" : [ { + "@value" : "An address is a collection of information, presented in a mostly fixed format, used for describing the location of a building, apartment, or other structure or a plot of land, generally using political boundaries and street names as references, along with other identifiers such as house or apartment numbers. Some addresses also contain special codes to aid routing of mail and packages, such as a ZIP code or post code. (Wikipedia)" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddressASCII", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "physical address ASCII" + } ], + "http://www.w3.org/2000/01/rdf-schema#subClassOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "An address transliterated to ASCII characters." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/RegistrationAuthority", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "registration authority" + } ], + "http://www.w3.org/2000/01/rdf-schema#subClassOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2004/02/skos/core#altLabel" : [ { + "@value" : "RA" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "An organization that is responsible for maintaining a registry and provides registration services." + } ], + "http://www.w3.org/2004/02/skos/core#prefLabel" : [ { + "@value" : "registration authority" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/RegistrationStatus", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "registration status" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "A lifecycle stage indicating the status of a given registration of something, such as a business or legal entity." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/Registry", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "registry" + } ], + "http://www.w3.org/2000/01/rdf-schema#subClassOf" : [ { + "@id" : "_:genid31" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "A system, typically an information system, that records the registration of items." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/RegistryEntry", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "registry entry" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "An entry in a registry that specifies something about the thing that is recorded." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/RegistryIdentifier", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "registry identifier" + } ], + "http://www.w3.org/2000/01/rdf-schema#subClassOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Identifier" + }, { + "@id" : "_:genid32" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "An identifier associated with an entry in a registry, i.e., one that provides an index to the registry for the recorded item." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasAbbreviation", + "@type" : [ "http://www.w3.org/2002/07/owl#AnnotationProperty", "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has abbreviation" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "http://www.w3.org/2004/02/skos/core#altLabel" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "An abbreviation for the entity identified." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasAbbreviationLocal", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has abbreviation local" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasAbbreviation" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "An abbreviation using a language local to the entity identified; may be English." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasAbbreviationTransliterated", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has abbreviation transliterated" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasAbbreviation" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "An abbreviation transliterated into a Western alphabet." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasAdditionalAddressLine", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has additional address line" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Means to collect the one to three specifically-named optional additional address line elements." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasAddress", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has address" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Has a means by which the entity may be located or contacted or may receive correspondence." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressHeadquarters", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has address headquarters" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasAddress" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "An address of the headquarters of the Entity." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressLegal", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has address legal" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasAddress" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "An address of the entity as recorded in the registration of the entity in its legal jurisdiction." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressLine1", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has address line 1" + } ], + "http://www.w3.org/2002/07/owl#equivalentProperty" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasFirstAddressLine" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The mandatory first address line element." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressLine2", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has address line 2" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasAdditionalAddressLine" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The second line of the one to three optional additional address line elements." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressLine3", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has address line 3" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasAdditionalAddressLine" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The third line of the one to three optional additional address line elements." + } ], + "http://www.w3.org/2004/02/skos/core#note" : [ { + "@value" : "This element SHALL be omitted if address line 2 is omitted." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressLine4", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has address line 4" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasAdditionalAddressLine" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The fourth line of the one to three optional additional address line elements." + } ], + "http://www.w3.org/2004/02/skos/core#note" : [ { + "@value" : "This element SHALL be omitted if address line 3 is omitted." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressNumber", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has address number" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Optional, additional structured version of an external house number, or range of numbers, contained in one of the address line elements." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressNumberWithinBuilding", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has address number within building" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Optional, additional structured version of an internal location number, or range of numbers, contained in one of the address line elements." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasAddressTransliterated", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has address transliterated" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddressASCII" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasAddress" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "An address which has been converted from original to western text." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasCity", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has city" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The mandatory name of the city." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasCountry", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has country" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "https://www.omg.org/spec/LCC/Countries/CountryRepresentation/Country" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasGeographicRegion" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The country, based on the 2-character ISO 3166-1 country code." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasCoverageArea", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has coverage area" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "https://www.omg.org/spec/LCC/Countries/CountryRepresentation/GeographicRegion" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Indicates a geographic region in which some service is provided, or to which some policy applies, or in which something is available." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasEnd", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Period" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@language" : "en", + "@value" : "has end" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "http://www.w3.org/2001/XMLSchema#dateTime" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The end time of a period." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasEntityExpirationDate", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has entity expiration date" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "http://www.w3.org/2001/XMLSchema#dateTime" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The date that the entity ceased to operate, whether due to dissolution, merger or acquisition." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasEntityExpirationReason", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has entity expiration reason" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "https://www.gleif.org/ontology/Base/EntityExpirationReason" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The reason that an entity ceased to exist and/or operate." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasEntityStatus", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty", "http://www.w3.org/2002/07/owl#FunctionalProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has entity status" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "https://www.gleif.org/ontology/Base/EntityStatus" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Indicates the status of the entity (i.e., active, inactive)." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasFirstAddressLine", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has first address line" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The mandatory first address line element." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasGeographicRegion", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has geographic region" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "https://www.omg.org/spec/LCC/Countries/CountryRepresentation/GeographicRegion" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The country or region where something is located." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasInitialRegistrationDate", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has initial registration date" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "http://www.w3.org/2001/XMLSchema#dateTime" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "http://purl.org/dc/terms/created" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The date on which an identifier or other registered item was first registered." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasLastUpdateDate", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has last modification date" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "http://www.w3.org/2001/XMLSchema#dateTime" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "http://purl.org/dc/terms/modified" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The date that the detail of a specific registration in the registry was last revised." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasLegalJurisdiction", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has legal jurisdiction" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "https://www.omg.org/spec/LCC/Countries/CountryRepresentation/GeographicRegion" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The jurisdiction of legal formation and registration of the entity (and upon which the LegalForm data element is also dependent). " + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasLegalName", + "@type" : [ "http://www.w3.org/2002/07/owl#AnnotationProperty" ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasMailRouting", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "mail routing" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Optional free text address line to hold content from other address lines containing explicit routing information (this element's presence indicates that this address is a routing / 'care of' address)." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasName", + "@type" : [ "http://www.w3.org/2002/07/owl#AnnotationProperty", "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has name" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "http://www.w3.org/2000/01/rdf-schema#label" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Associates a name, reference name, or appellation with an individual resource." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameASCII", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has name ASCII" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasNameTransliterated" + } ], + "http://www.w3.org/2004/02/skos/core#altLabel" : [ { + "@value" : "has ASCII name" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The name used to refer to a person or organization in 7 bit ASCII text (ISO 646); also valid UNICODE (ISO 10646)." + } ], + "http://www.w3.org/2004/02/skos/core#prefLabel" : [ { + "@value" : "has name ASCII" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameASCIIAutomatic", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has name ASCII automatic" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasNameASCII" + }, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameLegal" + } ], + "http://www.w3.org/2004/02/skos/core#altLabel" : [ { + "@value" : "has auto ASCII transliterated legal name" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Legal name of the entity transliterated to ASCII characters, auto-transliterated by the managing LOU." + } ], + "http://www.w3.org/2004/02/skos/core#prefLabel" : [ { + "@value" : "has name ASCII automatic" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameASCIIPreferred", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has name ASCII preferred" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasNameASCII" + }, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameLegal" + } ], + "http://www.w3.org/2004/02/skos/core#altLabel" : [ { + "@value" : "has preferred transliterated legal name" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Legal name of the entity transliterated to ASCII characters, provided by the entity for this purpose." + } ], + "http://www.w3.org/2004/02/skos/core#prefLabel" : [ { + "@value" : "has name ASCII preferred" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameAdditional", + "@type" : [ "http://www.w3.org/2002/07/owl#AnnotationProperty", "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has name additional" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "http://www.w3.org/2004/02/skos/core#altLabel" + }, { + "@id" : "https://www.gleif.org/ontology/Base/hasName" + } ], + "http://www.w3.org/2004/02/skos/core#altLabel" : [ { + "@value" : "has other name" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The name used to refer to an person or organization informally." + } ], + "http://www.w3.org/2004/02/skos/core#prefLabel" : [ { + "@value" : "has name additional" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameAdditionalLocal", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has name additional local" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasNameAdditional" + }, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameLocal" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Registered name of the entity in an alternative language in the legal jurisdiction in which the entity is registered." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameLegal", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has name legal" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasName" + } ], + "http://www.w3.org/2004/02/skos/core#altLabel" : [ { + "@value" : "has legal name" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The name used to refer to an person or organization in legal communications." + } ], + "http://www.w3.org/2004/02/skos/core#prefLabel" : [ { + "@value" : "has name legal" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameLegalLocal", + "@type" : [ "http://www.w3.org/2002/07/owl#AnnotationProperty", "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has name legal local" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "http://www.w3.org/2004/02/skos/core#prefLabel" + }, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameLegal" + }, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameLocal" + } ], + "http://www.w3.org/2004/02/skos/core#altLabel" : [ { + "@value" : "has local legal name" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The name used to refer to an person or organization in legal communications in local alphabet, which may be English." + } ], + "http://www.w3.org/2004/02/skos/core#prefLabel" : [ { + "@value" : "has name legal local" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameLocal", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has name local" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasName" + } ], + "http://www.w3.org/2004/02/skos/core#altLabel" : [ { + "@value" : "has local name" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "A name in a language local to the entity identified; may be English." + } ], + "http://www.w3.org/2004/02/skos/core#prefLabel" : [ { + "@value" : "has name local" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasNamePreviousLegal", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has name previous legal" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasNameAdditional" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "A primary legal name previously used by this entity." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameTradingOrOperating", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has name trading or operating" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasNameAdditional" + } ], + "http://www.w3.org/2004/02/skos/core#altLabel" : [ { + "@value" : "brand name" + }, { + "@value" : "doing business as" + }, { + "@value" : "has trading or operating name" + }, { + "@value" : "operating under" + }, { + "@value" : "trading as" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "A 'trading as', 'brand name' or 'operating under' name currently used by this entity in addition to, but not replacing, the (primary) legal, official registered name" + } ], + "http://www.w3.org/2004/02/skos/core#prefLabel" : [ { + "@value" : "has name trading or operating" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameTranslatedEnglish", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has name translated English" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasNameASCII" + } ], + "http://www.w3.org/2004/02/skos/core#altLabel" : [ { + "@value" : "has English name" + }, { + "@value" : "has international name" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The name used to refer to a person or organization, translated into English. Transliterated to ASCII by definition." + } ], + "http://www.w3.org/2004/02/skos/core#prefLabel" : [ { + "@value" : "has name translated English" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasNameTransliterated", + "@type" : [ "http://www.w3.org/2002/07/owl#AnnotationProperty", "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has name transliterated" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "http://www.w3.org/2004/02/skos/core#altLabel" + }, { + "@id" : "https://www.gleif.org/ontology/Base/hasName" + } ], + "http://www.w3.org/2004/02/skos/core#altLabel" : [ { + "@value" : "has transliterated name" + }, { + "@value" : "has transliterated other names" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The name used to refer to a person or organization, converted from original to western text. Not generally the legal name." + } ], + "http://www.w3.org/2004/02/skos/core#prefLabel" : [ { + "@value" : "has name transliterated" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasNextRenewalDate", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has next renewal date" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "http://www.w3.org/2001/XMLSchema#dateTime" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The date by which a specific registration in the registry must be renewed or updated." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasPostalCode", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/PhysicalAddress" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has postal code" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The (optional) postal code of this address as specified by the local postal service." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasRegion", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has region" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "https://www.omg.org/spec/LCC/Countries/CountryRepresentation/CountrySubdivision" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "https://www.gleif.org/ontology/Base/hasGeographicRegion" + } ], + "http://www.w3.org/2004/02/skos/core#altLabel" : [ { + "@value" : "has state" + }, { + "@value" : "has subdivision" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The (optional) region or subdivision (state, province, region, etc.) based on the 4- to 6-character ISO 3166-2 region code" + } ], + "http://www.w3.org/2004/02/skos/core#prefLabel" : [ { + "@value" : "has region" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasRegistrationStatus", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty", "http://www.w3.org/2002/07/owl#FunctionalProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has registration status" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "https://www.gleif.org/ontology/Base/RegistrationStatus" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "indicates the status of a specific registration, such as for an identifier or license" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasSource", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty", "http://www.w3.org/2002/07/owl#FunctionalProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/LegalEntityRelationship" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has source" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The entity that is the source of the directed relationship." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasStart", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Period" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@language" : "en", + "@value" : "has start" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "http://www.w3.org/2001/XMLSchema#dateTime" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The start time of a period." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasSuccessor", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has successor" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The surviving/new entity which continues/replaces this registration." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasSuccessorName", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has successor name" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The name of the successor entity." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasTag", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty", "http://www.w3.org/2002/07/owl#FunctionalProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has tag" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "http://www.w3.org/2001/XMLSchema#string" + } ], + "http://www.w3.org/2000/01/rdf-schema#subPropertyOf" : [ { + "@id" : "http://www.w3.org/2004/02/skos/core#notation" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Has a unique combination of alphanumeric characters or binary representation corresponding to the identifier, code, or other element to which it applies." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasTarget", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty", "http://www.w3.org/2002/07/owl#FunctionalProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/LegalEntityRelationship" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has target" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Entity" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The entity that plays the target of the directed relationship." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/hasWebsite", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "has website" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "http://www.w3.org/2001/XMLSchema#anyURI" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "A website associated with something, including but not limited to an organization." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/identifies", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty", "http://www.w3.org/2002/07/owl#FunctionalProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "identifies" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The relationship between an identifier and the thing it uniquely identifies." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/isManagedBy", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "is managed by" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Relates something to another thing that has some role in directing its affairs." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/isQualifiedBy", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/LegalEntityRelationship" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "is qualified by" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Any additional qualitative properties that help to categorize the relationship." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/isQuantifiedBy", + "@type" : [ "http://www.w3.org/2002/07/owl#DatatypeProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/LegalEntityRelationship" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "is quantified by" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "http://www.w3.org/2001/XMLSchema#decimal" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "Any additional quantitative properties that help to categorize the relationship." + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/isRegisteredIn", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty" ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "is registered in" + } ], + "http://www.w3.org/2000/01/rdf-schema#range" : [ { + "@id" : "https://www.gleif.org/ontology/Base/Registry" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "indicates the registry that something is registered in" + } ] +}, { + "@id" : "https://www.gleif.org/ontology/Base/records", + "@type" : [ "http://www.w3.org/2002/07/owl#ObjectProperty", "http://www.w3.org/2002/07/owl#FunctionalProperty" ], + "http://www.w3.org/2000/01/rdf-schema#domain" : [ { + "@id" : "https://www.gleif.org/ontology/Base/RegistryEntry" + } ], + "http://www.w3.org/2000/01/rdf-schema#isDefinedBy" : [ { + "@id" : "https://www.gleif.org/ontology/Base/" + } ], + "http://www.w3.org/2000/01/rdf-schema#label" : [ { + "@value" : "records" + } ], + "http://www.w3.org/2004/02/skos/core#definition" : [ { + "@value" : "The thing which the registry entry is a record of." + } ] +}, { + "@id" : "https://www.omg.org/spec/LCC/Countries/CountryRepresentation/Region", + "@type" : [ "http://www.w3.org/2002/07/owl#Class" ] +} ] \ No newline at end of file diff --git a/lei.json b/lei.json new file mode 100644 index 0000000..8832527 --- /dev/null +++ b/lei.json @@ -0,0 +1,38 @@ +[ + { + "LEI": { "$": "254900C9UJMDGJ0ILK56" }, + "Entity": { + "LegalName": { "$": "FreightTrust and Clearing, Inc." }, + "OtherEntityNames": { "OtherEntityName": [{ "@type": "TRADING_OR_OPERATING_NAME", "$": "Freight Trust and Clearing" }] }, + "LegalAddress": { + "FirstAddressLine": { "$": "c/o ROCKET LAWYER CORPORATE SERVICES LLC" }, + "AdditionalAddressLine": [{ "$": "2035 SUNSET LAKE RD" }, { "$": "SUITE B-2" }], + "City": { "$": "NEWARK" }, + "Region": { "$": "US-DE" }, + "Country": { "$": "US" }, + "PostalCode": { "$": "19702" } + }, + "HeadquartersAddress": { + "FirstAddressLine": { "$": "1424 4th St Ste 214" }, + "AdditionalAddressLine": [{ "$": "PMB 1513" }], + "City": { "$": "Santa Monica" }, + "Region": { "$": "US-CA" }, + "Country": { "$": "US" }, + "PostalCode": { "$": "90401" } + }, + "RegistrationAuthority": { "RegistrationAuthorityID": { "$": "RA000602" }, "RegistrationAuthorityEntityID": { "$": "7650005" } }, + "LegalJurisdiction": { "$": "US-DE" }, + "LegalForm": { "EntityLegalFormCode": { "$": "XTIQ" } }, + "EntityStatus": { "$": "ACTIVE" } + }, + "Registration": { + "InitialRegistrationDate": { "$": "2020-05-11T11:47:13.761Z" }, + "LastUpdateDate": { "$": "2020-05-11T11:47:13.761Z" }, + "RegistrationStatus": { "$": "ISSUED" }, + "NextRenewalDate": { "$": "2021-05-11T11:47:13.761Z" }, + "ManagingLOU": { "$": "5493001KJTIIGC8Y1R12" }, + "ValidationSources": { "$": "FULLY_CORROBORATED" }, + "ValidationAuthority": { "ValidationAuthorityID": { "$": "RA000602" }, "ValidationAuthorityEntityID": { "$": "7650005" } } + } + } +] diff --git a/lei/README.md b/lei/README.md new file mode 100644 index 0000000..e20cdfe --- /dev/null +++ b/lei/README.md @@ -0,0 +1,106 @@ +# LEI Informative + +curl --request GET 'https://leilookup.gleif.org/api/v2/leirecords?lei=254900C9UJMDGJ0ILK56' --header 'Content-Type: application/json' --data-raw '[]' + +```json +[{"LEI":{"$":"254900C9UJMDGJ0ILK56"},"Entity":{"LegalName":{"$":"FreightTrust and Clearing, Inc."},"OtherEntityNames":{"OtherEntityName":[{"@type":"TRADING_OR_OPERATING_NAME","$":"Freight Trust and Clearing"}]},"LegalAddress":{"FirstAddressLine":{"$":"c\/o ROCKET LAWYER CORPORATE SERVICES LLC"},"AdditionalAddressLine":[{"$":"2035 SUNSET LAKE RD"},{"$":"SUITE B-2"}],"City":{"$":"NEWARK"},"Region":{"$":"US-DE"},"Country":{"$":"US"},"PostalCode":{"$":"19702"}},"HeadquartersAddress":{"FirstAddressLine":{"$":"1424 4th St Ste 214"},"AdditionalAddressLine":[{"$":"PMB 1513"}],"City":{"$":"Santa Monica"},"Region":{"$":"US-CA"},"Country":{"$":"US"},"PostalCode":{"$":"90401"}},"RegistrationAuthority":{"RegistrationAuthorityID":{"$":"RA000602"},"RegistrationAuthorityEntityID":{"$":"7650005"}},"LegalJurisdiction":{"$":"US-DE"},"LegalForm":{"EntityLegalFormCode":{"$":"XTIQ"}},"EntityStatus":{"$":"ACTIVE"}},"Registration":{"InitialRegistrationDate":{"$":"2020-05-11T11:47:13.761Z"},"LastUpdateDate":{"$":"2020-05-11T11:47:13.761Z"},"RegistrationStatus":{"$":"ISSUED"},"NextRenewalDate":{"$":"2021-05-11T11:47:13.761Z"},"ManagingLOU":{"$":"5493001KJTIIGC8Y1R12"},"ValidationSources":{"$":"FULLY_CORROBORATED"},"ValidationAuthority":{"ValidationAuthorityID":{"$":"RA000602"},"ValidationAuthorityEntityID":{"$":"7650005"}}}}] +``` + +unminifed... + +```json +[ + { + "LEI": { "$": "254900C9UJMDGJ0ILK56" }, + "Entity": { + "LegalName": { "$": "FreightTrust and Clearing, Inc." }, + "OtherEntityNames": { "OtherEntityName": [{ "@type": "TRADING_OR_OPERATING_NAME", "$": "Freight Trust and Clearing" }] }, + "LegalAddress": { + "FirstAddressLine": { "$": "c/o ROCKET LAWYER CORPORATE SERVICES LLC" }, + "AdditionalAddressLine": [{ "$": "2035 SUNSET LAKE RD" }, { "$": "SUITE B-2" }], + "City": { "$": "NEWARK" }, + "Region": { "$": "US-DE" }, + "Country": { "$": "US" }, + "PostalCode": { "$": "19702" } + }, + "HeadquartersAddress": { + "FirstAddressLine": { "$": "1424 4th St Ste 214" }, + "AdditionalAddressLine": [{ "$": "PMB 1513" }], + "City": { "$": "Santa Monica" }, + "Region": { "$": "US-CA" }, + "Country": { "$": "US" }, + "PostalCode": { "$": "90401" } + }, + "RegistrationAuthority": { "RegistrationAuthorityID": { "$": "RA000602" }, "RegistrationAuthorityEntityID": { "$": "7650005" } }, + "LegalJurisdiction": { "$": "US-DE" }, + "LegalForm": { "EntityLegalFormCode": { "$": "XTIQ" } }, + "EntityStatus": { "$": "ACTIVE" } + }, + "Registration": { + "InitialRegistrationDate": { "$": "2020-05-11T11:47:13.761Z" }, + "LastUpdateDate": { "$": "2020-05-11T11:47:13.761Z" }, + "RegistrationStatus": { "$": "ISSUED" }, + "NextRenewalDate": { "$": "2021-05-11T11:47:13.761Z" }, + "ManagingLOU": { "$": "5493001KJTIIGC8Y1R12" }, + "ValidationSources": { "$": "FULLY_CORROBORATED" }, + "ValidationAuthority": { "ValidationAuthorityID": { "$": "RA000602" }, "ValidationAuthorityEntityID": { "$": "7650005" } } + } + } +] + +``` + + + + +### CAA Verification + +Fetch Issued CAA Certification Policy + +[cert transparency.org](https://www.certificate-transparency.org/) + +```bash +freighttrust.com. IN CAA 0 issue "digicert.com" +freighttrust.com. IN CAA 0 issue "letsencrypt.org" +freighttrust.com. IN CAA 0 issue "sectigo.com" +``` + +parse lei.bloomberg.com + +search for... `
` + +let HashingOutput = Base64URL( Multihash(DATA, 'sha2-256') ); + + +### terms + +`credentials`: [source](https://www.w3.org/TR/vc-data-model/#dfn-verifiable-credentials) + +`derived predicate` +A verifiable, boolean assertion about the value of another attribute in a verifiable credential. + + +## Minimal DID +[source](https://w3c.github.io/did-core/#a-simple-example_) + + +```json +{ + "@context": "https://www.w3.org/ns/did/v1", + "id": "did:example:123456789abcdefghi", + "authentication": [{ + + "id": "did:example:123456789abcdefghi#keys-1", + "type": "Ed25519VerificationKey2018", + "controller": "did:example:123456789abcdefghi", + "publicKeyBase58": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV" + }], + "service": [{ + + "id":"did:example:123456789abcdefghi#vcs", + "type": "VerifiableCredentialService", + "serviceEndpoint": "https://example.com/vc/" + }] +} +``` + diff --git a/lib/freight/configuration.ts b/lib/freight/configuration.ts new file mode 100644 index 0000000..a7558e1 --- /dev/null +++ b/lib/freight/configuration.ts @@ -0,0 +1,81 @@ +export interface ConfigurationParameters { + apiKeys?: {[ key: string ]: string}; + username?: string; + password?: string; + accessToken?: string | (() => string); + basePath?: string; + withCredentials?: boolean; +} + +export class Configuration { + apiKeys?: {[ key: string ]: string}; + username?: string; + password?: string; + accessToken?: string | (() => string); + basePath?: string; + withCredentials?: boolean; + + constructor(configurationParameters: ConfigurationParameters = {}) { + this.apiKeys = configurationParameters.apiKeys; + this.username = configurationParameters.username; + this.password = configurationParameters.password; + this.accessToken = configurationParameters.accessToken; + this.basePath = configurationParameters.basePath; + this.withCredentials = configurationParameters.withCredentials; + } + + /** + * Select the correct content-type to use for a request. + * Uses {@link Configuration#isJsonMime} to determine the correct content-type. + * If no content type is found return the first found type if the contentTypes is not empty + * @param contentTypes - the array of content types that are available for selection + * @returns the selected content-type or undefined if no selection could be made. + */ + public selectHeaderContentType (contentTypes: string[]): string | undefined { + if (contentTypes.length == 0) { + return undefined; + } + + let type = contentTypes.find(x => this.isJsonMime(x)); + if (type === undefined) { + return contentTypes[0]; + } + return type; + } + + /** + * Select the correct accept content-type to use for a request. + * Uses {@link Configuration#isJsonMime} to determine the correct accept content-type. + * If no content type is found return the first found type if the contentTypes is not empty + * @param accepts - the array of content types that are available for selection. + * @returns the selected content-type or undefined if no selection could be made. + */ + public selectHeaderAccept(accepts: string[]): string | undefined { + if (accepts.length == 0) { + return undefined; + } + + let type = accepts.find(x => this.isJsonMime(x)); + if (type === undefined) { + return accepts[0]; + } + return type; + } + + /** + * Check if the given MIME is a JSON MIME. + * JSON MIME examples: + * application/json + * application/json; charset=UTF8 + * APPLICATION/JSON + * application/company+json + * TODO: Add application/edi+ support + * TODO: See Clubhouse + * @param mime - MIME (Multipurpose Internet Mail Extensions) + * @return True if the given MIME is JSON, false otherwise. + */ + public isJsonMime(mime: string): boolean { + const jsonMime: RegExp = new RegExp('^(application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(;.*)?$', 'i'); + return mime != null && (jsonMime.test(mime) || mime.toLowerCase() === 'application/json-patch+json'); + } +} diff --git a/lib/freight/events.service.ts b/lib/freight/events.service.ts new file mode 100644 index 0000000..24baf03 --- /dev/null +++ b/lib/freight/events.service.ts @@ -0,0 +1,156 @@ +/* tslint:disable:no-unused-variable member-ordering */ + +import { Inject, Injectable, Optional } from '@angular/core'; +// import { HttpClient, HttpHeaders, HttpParams, +// HttpResponse, HttpEvent } from '@angular/common/http'; +import { CustomHttpUrlEncodingCodec } from '/encoder'; + +import { Observable } from 'rxjs'; + +import { BillOfLadingNumber } from './ts/billOfLadingNumber'; +import { BookingReference } from './ts/bookingReference'; +import { EquipmentReference } from './ts/equipmentReference'; +import { EventTypeList } from './ts/eventTypeList'; +import { Events } from './ts/events'; +import { InlineResponse200 } from './ts/inlineResponse200'; + +import { BASE_PATH, COLLECTION_FORMATS } from '/variables'; +import { Configuration } from '/configuration'; + + +@Injectable() +export class EventsService { + + // protected basePath = 'https://services.freighttrust.com/base'; + // public defaultHeaders = new HttpHeaders(); + public configuration = new Configuration(); +/* + // constructor(protected httpClient: HttpClient, @Optional()@Inject(BASE_PATH) basePath: string, @Optional() configuration: Configuration) { + if (basePath) { + this.basePath = basePath; + } + if (configuration) { + this.configuration = configuration; + this.basePath = basePath || configuration.basePath || this.basePath; + } + } + + /** + * @param consumes string[] mime-types + * @return true: consumes contains 'multipart/form-data', false: otherwise + */ + private canConsumeForm(consumes: string[]): boolean { + const form = 'multipart/form-data'; + for (const consume of consumes) { + if (form === consume) { + return true; + } + } + return false; + } + + + /** + * Find events by eventID. + * Returns event with the specified eventID. + * @param eventID The ID of the event to receive + * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. + * @param reportProgress flag to report request and response progress. + */ + public eventsEventIDGet(eventID: string, observe?: 'body', reportProgress?: boolean): Observable; + public eventsEventIDGet(eventID: string, observe?: 'response', reportProgress?: boolean): Observable>; + public eventsEventIDGet(eventID: string, observe?: 'events', reportProgress?: boolean): Observable>; + public eventsEventIDGet(eventID: string, observe: any = 'body', reportProgress: boolean = false ): Observable { + + if (eventID === null || eventID === undefined) { + throw new Error('Required parameter eventID was null or undefined when calling eventsEventIDGet.'); + } + + // let headers = this.defaultHeaders; + + // to determine the Accept header + let httpHeaderAccepts: string[] = [ + 'application/json' + ]; + const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts); + if (httpHeaderAcceptSelected != undefined) { + // headers = headers.set('Accept', httpHeaderAcceptSelected); + } + + // to determine the Content-Type header + const consumes: string[] = [ + ]; +/** + return this.httpClient.request('get',`${this.basePath}/events/${encodeURIComponent(String(eventID))}`, + { + withCredentials: this.configuration.withCredentials, + headers: headers, + observe: observe, + reportProgress: reportProgress + } + ); + } + + /** + * Find events by type, Booking Reference, Bill of Lading or Equipment Reference. + * Returns all events filtered by the parameters. + * @param eventType The type of event(s) to filter by. + * @param bookingReference The identifier for a shipment, which is issued by and unique within each of the carriers. + * @param billOfLadingNumber Bill of lading number is an identifier that links to a shipment. Bill of Lading is the legal document issued to the customer, which confirms the carrier's receipt of the cargo from the customer acknowledging goods being shipped and specifying the terms of delivery. + * @param equipmentReference The unique identifier for the equipment, which should follow the BIC ISO Container Identification Number where possible. + * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body. + * @param reportProgress flag to report request and response progress. + */ + // public eventsGet(eventType?: EventTypeList, bookingReference?: BookingReference, billOfLadingNumber?: BillOfLadingNumber, equipmentReference?: EquipmentReference, observe?: 'body', reportProgress?: boolean): Observable; + // public eventsGet(eventType?: EventTypeList, bookingReference?: BookingReference, billOfLadingNumber?: BillOfLadingNumber, equipmentReference?: EquipmentReference, observe?: 'response', reportProgress?: boolean): Observable>; + // public eventsGet(eventType?: EventTypeList, bookingReference?: BookingReference, billOfLadingNumber?: BillOfLadingNumber, equipmentReference?: EquipmentReference, observe?: 'events', reportProgress?: boolean): Observable>; + // public eventsGet(eventType?: EventTypeList, bookingReference?: BookingReference, billOfLadingNumber?: BillOfLadingNumber, equipmentReference?: EquipmentReference, observe: any = 'body', reportProgress: boolean = false ): Observable { + + + + +/* + let queryParameters = new HttpParams({encoder: new CustomHttpUrlEncodingCodec()}); + if (eventType !== undefined && eventType !== null) { + queryParameters = queryParameters.set('eventType', eventType); + } + if (bookingReference !== undefined && bookingReference !== null) { + queryParameters = queryParameters.set('bookingReference', bookingReference); + } + if (billOfLadingNumber !== undefined && billOfLadingNumber !== null) { + queryParameters = queryParameters.set('billOfLadingNumber', billOfLadingNumber); + } + if (equipmentReference !== undefined && equipmentReference !== null) { + queryParameters = queryParameters.set('equipmentReference', equipmentReference); + } + + let headers = this.defaultHeaders; + + // to determine the Accept header + let httpHeaderAccepts: string[] = [ + 'application/json' + ]; + const httpHeaderAcceptSelected: string | undefined = this.configuration.selectHeaderAccept(httpHeaderAccepts); + if (httpHeaderAcceptSelected != undefined) { + headers = headers.set('Accept', httpHeaderAcceptSelected); + } + + // to determine the Content-Type header + const consumes: string[] = [ + ]; + + return this.httpClient.request('get',`${this.basePath}/events`, + { + params: queryParameters, + withCredentials: this.configuration.withCredentials, + headers: headers, + observe: observe, + reportProgress: reportProgress + } + ); + } + +} +*/ + } +} \ No newline at end of file diff --git a/lib/freight/freight.module.ts b/lib/freight/freight.module.ts new file mode 100644 index 0000000..ce0316c --- /dev/null +++ b/lib/freight/freight.module.ts @@ -0,0 +1,35 @@ +import { NgModule, ModuleWithProviders, SkipSelf, Optional } from '@angular/core'; +import { Configuration } from './configuration'; +// import { HttpClient } from 'your module'; + + +import { EventsService } from './events.service'; +import { SubscriptionsService } from './subscriptions.service'; + +@NgModule({ + imports: [], + declarations: [], + exports: [], + providers: [ + EventsService, + SubscriptionsService ] +}) +export class FreightModule { + public static forRoot(configurationFactory: () => Configuration): ModuleWithProviders { + return { + Module: FreightModule, + providers: [ { provide: Configuration, useFactory: configurationFactory } ] + }; + } + + constructor( @Optional() @SkipSelf() parentModule: ApiModule, + @Optional() http: HttpClient) { + if (parentModule) { + throw new Error('ApiModule is already loaded. Import in your base AppModule only.'); + } + if (!http) { + throw new Error('You need to import the HttpClientModule in your AppModule! \n' + + 'See also https://github.com/angular/angular/issues/20575'); + } + } +} diff --git a/lib/freight/index.ts b/lib/freight/index.ts new file mode 100644 index 0000000..a7d5aa2 --- /dev/null +++ b/lib/freight/index.ts @@ -0,0 +1,3 @@ +export * from './ts'; +export * from './variables'; +export * from './configuration'; \ No newline at end of file diff --git a/lib/freight/ts/billOfLadingNumber.ts b/lib/freight/ts/billOfLadingNumber.ts new file mode 100644 index 0000000..d3f300c --- /dev/null +++ b/lib/freight/ts/billOfLadingNumber.ts @@ -0,0 +1,5 @@ + +/** + * Bill of lading number is an identifier that links to a shipment. Bill of Lading is the legal document issued to the customer, which confirms the carrier's receipt of the cargo from the customer acknowledging goods being shipped and specifying the terms of delivery. + */ +export type BillOfLadingNumber = string; \ No newline at end of file diff --git a/lib/freight/ts/bookingReference.ts b/lib/freight/ts/bookingReference.ts new file mode 100644 index 0000000..2b8f7eb --- /dev/null +++ b/lib/freight/ts/bookingReference.ts @@ -0,0 +1,6 @@ +] + +/** + * The identifier for a shipment, which is issued by and unique within each of the carriers. + */ +export type BookingReference = string; \ No newline at end of file diff --git a/lib/freight/ts/callbackUrl.ts b/lib/freight/ts/callbackUrl.ts new file mode 100644 index 0000000..140aaf1 --- /dev/null +++ b/lib/freight/ts/callbackUrl.ts @@ -0,0 +1,6 @@ + + +/** + * Your server, where the API server should send the event data + */ +export type CallbackUrl = string; \ No newline at end of file diff --git a/lib/freight/ts/emptyIndicatorCode.ts b/lib/freight/ts/emptyIndicatorCode.ts new file mode 100644 index 0000000..7bbb6c0 --- /dev/null +++ b/lib/freight/ts/emptyIndicatorCode.ts @@ -0,0 +1,6 @@ + + +/** + * Code to denote whether the equipment is empty or laden. + */ +export type EmptyIndicatorCode = string; \ No newline at end of file diff --git a/lib/freight/ts/equipmentEvent.ts b/lib/freight/ts/equipmentEvent.ts new file mode 100644 index 0000000..4a3eabb --- /dev/null +++ b/lib/freight/ts/equipmentEvent.ts @@ -0,0 +1,31 @@ + +import { EmptyIndicatorCode } from './emptyIndicatorCode'; +import { EquipmentReference } from './equipmentReference'; +import { Event } from './event'; +import { EventClassifierCode } from './eventClassifierCode'; +import { EventDateTime } from './eventDateTime'; +import { EventID } from './eventID'; +import { EventTypeCode } from './eventTypeCode'; +import { FacilityCode } from './facilityCode'; +import { FacilityTypeCode } from './facilityTypeCode'; +import { OtherFacility } from './otherFacility'; +import { UNLocationCode } from './uNLocationCode'; + +/** + * The equipment event entity is a specialization of the event entity to support specification of data that only applies to an equipment event. + */ +export interface EquipmentEvent extends Event { + eventType?: EquipmentEvent.EventTypeEnum; + equipmentReference?: EquipmentReference; + facilityTypeCode: FacilityTypeCode; + uNLocationCode: UNLocationCode; + facilityCode: FacilityCode; + otherFacility?: OtherFacility; + emptyIndicatorCode: EmptyIndicatorCode; +} +export namespace EquipmentEvent { + export type EventTypeEnum = 'EQUIPMENT'; + export const EventTypeEnum = { + EQUIPMENT: 'EQUIPMENT' as EventTypeEnum + }; +} \ No newline at end of file diff --git a/lib/freight/ts/equipmentReference.ts b/lib/freight/ts/equipmentReference.ts new file mode 100644 index 0000000..ccdd5d0 --- /dev/null +++ b/lib/freight/ts/equipmentReference.ts @@ -0,0 +1,6 @@ + + +/** + * The unique identifier for the equipment, which should follow the BIC ISO Container Identification Number where possible. If a container is not yet assigned to a shipment, the interface cannot return any information when an equipment reference is given as input. If a container is assigned to an (active) shipment, the interface returns information on the active shipment. + */ +export type EquipmentReference = string; \ No newline at end of file diff --git a/lib/freight/ts/error.ts b/lib/freight/ts/error.ts new file mode 100644 index 0000000..2101018 --- /dev/null +++ b/lib/freight/ts/error.ts @@ -0,0 +1,26 @@ + +import { Errors } from './errors'; + +export interface Error { + /** + * The HTTP request method type + */ + httpMethod: string; + /** + * The request URI. + */ + requestUri: string; + errors: Errors; + /** + * The HTTP status code + */ + statusCode: string; + /** + * The textual representation of the response status. + */ + statusCodeText: string; + /** + * The date and time (in ISO 8601 format) the error occured. + */ + errorDateTime: string; +} \ No newline at end of file diff --git a/lib/freight/ts/errors.ts b/lib/freight/ts/errors.ts new file mode 100644 index 0000000..8e19a9e --- /dev/null +++ b/lib/freight/ts/errors.ts @@ -0,0 +1,5 @@ + +import { ErrorsInner } from './errorsInner'; + +export interface Errors extends Array { +} \ No newline at end of file diff --git a/lib/freight/ts/errorsInner.ts b/lib/freight/ts/errorsInner.ts new file mode 100644 index 0000000..a05aa4e --- /dev/null +++ b/lib/freight/ts/errorsInner.ts @@ -0,0 +1,12 @@ + + +export interface ErrorsInner { + /** + * High level error message. + */ + reason: string; + /** + * Detailed error message. + */ + message: string; +} \ No newline at end of file diff --git a/lib/freight/ts/event.ts b/lib/freight/ts/event.ts new file mode 100644 index 0000000..3609da7 --- /dev/null +++ b/lib/freight/ts/event.ts @@ -0,0 +1,17 @@ + +import { EventClassifierCode } from './eventClassifierCode'; +import { EventDateTime } from './eventDateTime'; +import { EventID } from './eventID'; +import { EventType } from './eventType'; +import { EventTypeCode } from './eventTypeCode'; + +/** + * The event entity is described as a generalization of all the specific event categories. An event always takes place in relation to a shipment and can additionally be linked to a transport or an equipment + */ +export interface Event { + eventID: EventID; + eventType: EventType; + eventDateTime: EventDateTime; + eventClassifierCode: EventClassifierCode; + eventTypeCode: EventTypeCode; +} \ No newline at end of file diff --git a/lib/freight/ts/eventClassifierCode.ts b/lib/freight/ts/eventClassifierCode.ts new file mode 100644 index 0000000..cfdcc06 --- /dev/null +++ b/lib/freight/ts/eventClassifierCode.ts @@ -0,0 +1,6 @@ + + +/** + * Code for the event classifier, either PLN, ACT or EST. + */ +export type EventClassifierCode = string; \ No newline at end of file diff --git a/lib/freight/ts/eventDateTime.ts b/lib/freight/ts/eventDateTime.ts new file mode 100644 index 0000000..01adba7 --- /dev/null +++ b/lib/freight/ts/eventDateTime.ts @@ -0,0 +1,6 @@ + + +/** + * The local date and time, where the event took place, in ISO 8601 format. + */ +export type EventDateTime = Date; \ No newline at end of file diff --git a/lib/freight/ts/eventID.ts b/lib/freight/ts/eventID.ts new file mode 100644 index 0000000..2f66bde --- /dev/null +++ b/lib/freight/ts/eventID.ts @@ -0,0 +1,6 @@ + + +/** + * The unique identifier for the Equipment Event ID/Transport Event ID/Shipment Event ID. + */ +export type EventID = string; \ No newline at end of file diff --git a/lib/freight/ts/eventSubscription.ts b/lib/freight/ts/eventSubscription.ts new file mode 100644 index 0000000..fe04e37 --- /dev/null +++ b/lib/freight/ts/eventSubscription.ts @@ -0,0 +1,16 @@ + +import { BillOfLadingNumber } from './billOfLadingNumber'; +import { BookingReference } from './bookingReference'; +import { CallbackUrl } from './callbackUrl'; +import { EquipmentReference } from './equipmentReference'; +import { EventSubscriptionBody } from './eventSubscriptionBody'; +import { EventTypeList } from './eventTypeList'; +import { SubscriptionID } from './subscriptionID'; + +export interface EventSubscription extends SubscriptionID { + callbackUrl: CallbackUrl; + eventType?: EventTypeList; + bookingReference?: BookingReference; + billOfLadingNumber?: BillOfLadingNumber; + equipmentReference?: EquipmentReference; +} \ No newline at end of file diff --git a/lib/freight/ts/eventSubscriptionBody.ts b/lib/freight/ts/eventSubscriptionBody.ts new file mode 100644 index 0000000..14fb365 --- /dev/null +++ b/lib/freight/ts/eventSubscriptionBody.ts @@ -0,0 +1,17 @@ + +import { BillOfLadingNumber } from './billOfLadingNumber'; +import { BookingReference } from './bookingReference'; +import { CallbackUrl } from './callbackUrl'; +import { EquipmentReference } from './equipmentReference'; +import { EventTypeList } from './eventTypeList'; + +/** + * The object used by the POST event-subscriptions endpoint + */ +export interface EventSubscriptionBody { + callbackUrl: CallbackUrl; + eventType?: EventTypeList; + bookingReference?: BookingReference; + billOfLadingNumber?: BillOfLadingNumber; + equipmentReference?: EquipmentReference; +} \ No newline at end of file diff --git a/lib/freight/ts/eventType.ts b/lib/freight/ts/eventType.ts new file mode 100644 index 0000000..a132d72 --- /dev/null +++ b/lib/freight/ts/eventType.ts @@ -0,0 +1,13 @@ + + +/** + * The Event Type of the object. + */ +export type EventType = 'EQUIPMENT' | 'SHIPMENT' | 'TRANSPORT' | 'TRANSPORTEQUIPMENT'; + +export const EventType = { + EQUIPMENT: 'EQUIPMENT' as EventType, + SHIPMENT: 'SHIPMENT' as EventType, + TRANSPORT: 'TRANSPORT' as EventType, + TRANSPORTEQUIPMENT: 'TRANSPORTEQUIPMENT' as EventType +}; \ No newline at end of file diff --git a/lib/freight/ts/eventTypeCode.ts b/lib/freight/ts/eventTypeCode.ts new file mode 100644 index 0000000..2a174aa --- /dev/null +++ b/lib/freight/ts/eventTypeCode.ts @@ -0,0 +1,6 @@ + + +/** + * Unique identifier for Event Type Code. + */ +export type EventTypeCode = string; \ No newline at end of file diff --git a/lib/freight/ts/eventTypeList.ts b/lib/freight/ts/eventTypeList.ts new file mode 100644 index 0000000..140dc78 --- /dev/null +++ b/lib/freight/ts/eventTypeList.ts @@ -0,0 +1,8 @@ + +import { EventType } from './eventType'; + +/** + * A list of event types. Default is all events + */ +export interface EventTypeList extends Array { +} \ No newline at end of file diff --git a/lib/freight/ts/events.ts b/lib/freight/ts/events.ts new file mode 100644 index 0000000..205f33b --- /dev/null +++ b/lib/freight/ts/events.ts @@ -0,0 +1,12 @@ + +import { EquipmentEvent } from './equipmentEvent'; +import { ShipmentEvent } from './shipmentEvent'; +import { TransportEquipmentEvent } from './transportEquipmentEvent'; +import { TransportEvent } from './transportEvent'; + +/** + * List of events for shipment journey. + */ +export interface Events { + events: Array; +} \ No newline at end of file diff --git a/lib/freight/ts/facilityCode.ts b/lib/freight/ts/facilityCode.ts new file mode 100644 index 0000000..24c7c09 --- /dev/null +++ b/lib/freight/ts/facilityCode.ts @@ -0,0 +1,6 @@ + + +/** + * The code used for identifying the specific facility. + */ +export type FacilityCode = string; \ No newline at end of file diff --git a/lib/freight/ts/facilityTypeCode.ts b/lib/freight/ts/facilityTypeCode.ts new file mode 100644 index 0000000..d9a8e4b --- /dev/null +++ b/lib/freight/ts/facilityTypeCode.ts @@ -0,0 +1,6 @@ + + +/** + * The code to identify the specific type of facility. + */ +export type FacilityTypeCode = string; \ No newline at end of file diff --git a/lib/freight/ts/inlineResponse200.ts b/lib/freight/ts/inlineResponse200.ts new file mode 100644 index 0000000..5a8fe78 --- /dev/null +++ b/lib/freight/ts/inlineResponse200.ts @@ -0,0 +1,7 @@ + +import { EquipmentEvent } from './equipmentEvent'; +import { ShipmentEvent } from './shipmentEvent'; +import { TransportEquipmentEvent } from './transportEquipmentEvent'; +import { TransportEvent } from './transportEvent'; + +export type InlineResponse200 = TransportEvent | ShipmentEvent | EquipmentEvent | TransportEquipmentEvent; \ No newline at end of file diff --git a/lib/freight/ts/modeOfTransportCode.ts b/lib/freight/ts/modeOfTransportCode.ts new file mode 100644 index 0000000..08ea54d --- /dev/null +++ b/lib/freight/ts/modeOfTransportCode.ts @@ -0,0 +1,6 @@ + + +/** + * A code specifying a type of transport mode. + */ +export type ModeOfTransportCode = string; \ No newline at end of file diff --git a/lib/freight/ts/models.ts b/lib/freight/ts/models.ts new file mode 100644 index 0000000..a64a7be --- /dev/null +++ b/lib/freight/ts/models.ts @@ -0,0 +1,32 @@ +export * from './billOfLadingNumber'; +export * from './bookingReference'; +export * from './callbackUrl'; +export * from './emptyIndicatorCode'; +export * from './equipmentEvent'; +export * from './equipmentReference'; +export * from './error'; +export * from './errors'; +export * from './errorsInner'; +export * from './event'; +export * from './eventClassifierCode'; +export * from './eventDateTime'; +export * from './eventID'; +export * from './eventSubscription'; +export * from './eventSubscriptionBody'; +export * from './eventType'; +export * from './eventTypeCode'; +export * from './eventTypeList'; +export * from './events'; +export * from './facilityCode'; +export * from './facilityTypeCode'; +export * from './inlineResponse200'; +export * from './modeOfTransportCode'; +export * from './otherFacility'; +export * from './shipmentEvent'; +export * from './shipmentInformationTypeCode'; +export * from './subscriptionID'; +export * from './transportEquipmentEvent'; +export * from './transportEvent'; +export * from './transportLegReference'; +export * from './transportReference'; +export * from './uNLocationCode'; diff --git a/lib/freight/ts/otherFacility.ts b/lib/freight/ts/otherFacility.ts new file mode 100644 index 0000000..3848e75 --- /dev/null +++ b/lib/freight/ts/otherFacility.ts @@ -0,0 +1,6 @@ + + +/** + * An alternative way to capture the facility when no standardized DCSA facility code can be found. + */ +export type OtherFacility = string; \ No newline at end of file diff --git a/lib/freight/ts/shipmentEvent.ts b/lib/freight/ts/shipmentEvent.ts new file mode 100644 index 0000000..de2ac79 --- /dev/null +++ b/lib/freight/ts/shipmentEvent.ts @@ -0,0 +1,21 @@ + +import { Event } from './event'; +import { EventClassifierCode } from './eventClassifierCode'; +import { EventDateTime } from './eventDateTime'; +import { EventID } from './eventID'; +import { EventTypeCode } from './eventTypeCode'; +import { ShipmentInformationTypeCode } from './shipmentInformationTypeCode'; + +/** + * The shipment event entity is a specialization of the event entity to support specification of data that only applies to a shipment event. + */ +export interface ShipmentEvent extends Event { + eventType?: ShipmentEvent.EventTypeEnum; + shipmentInformationTypeCode: ShipmentInformationTypeCode; +} +export namespace ShipmentEvent { + export type EventTypeEnum = 'SHIPMENT'; + export const EventTypeEnum = { + SHIPMENT: 'SHIPMENT' as EventTypeEnum + }; +} \ No newline at end of file diff --git a/lib/freight/ts/shipmentInformationTypeCode.ts b/lib/freight/ts/shipmentInformationTypeCode.ts new file mode 100644 index 0000000..07583ad --- /dev/null +++ b/lib/freight/ts/shipmentInformationTypeCode.ts @@ -0,0 +1,6 @@ + + +/** + * The code to identify the type of information that is related to the shipment. + */ +export type ShipmentInformationTypeCode = string; \ No newline at end of file diff --git a/lib/freight/ts/subscriptionID.ts b/lib/freight/ts/subscriptionID.ts new file mode 100644 index 0000000..bb23e4c --- /dev/null +++ b/lib/freight/ts/subscriptionID.ts @@ -0,0 +1,8 @@ + + +/** + * The carrier issues a unique ID to the shipper or consignee for that subscription + */ +export interface SubscriptionID { + subscriptionID?: string; +} \ No newline at end of file diff --git a/lib/freight/ts/transportEquipmentEvent.ts b/lib/freight/ts/transportEquipmentEvent.ts new file mode 100644 index 0000000..7edfb2f --- /dev/null +++ b/lib/freight/ts/transportEquipmentEvent.ts @@ -0,0 +1,37 @@ + +import { EmptyIndicatorCode } from './emptyIndicatorCode'; +import { EquipmentReference } from './equipmentReference'; +import { Event } from './event'; +import { EventClassifierCode } from './eventClassifierCode'; +import { EventDateTime } from './eventDateTime'; +import { EventID } from './eventID'; +import { EventTypeCode } from './eventTypeCode'; +import { FacilityCode } from './facilityCode'; +import { FacilityTypeCode } from './facilityTypeCode'; +import { ModeOfTransportCode } from './modeOfTransportCode'; +import { OtherFacility } from './otherFacility'; +import { TransportLegReference } from './transportLegReference'; +import { TransportReference } from './transportReference'; +import { UNLocationCode } from './uNLocationCode'; + +/** + * The transport equipment event entity is a specialization of the event entity to support specification of data that applies to both transport and equipment events. + */ +export interface TransportEquipmentEvent extends Event { + eventType?: TransportEquipmentEvent.EventTypeEnum; + transportReference: TransportReference; + transportLegReference: TransportLegReference; + equipmentReference?: EquipmentReference; + facilityTypeCode: FacilityTypeCode; + uNLocationCode: UNLocationCode; + facilityCode: FacilityCode; + otherFacility?: OtherFacility; + emptyIndicatorCode: EmptyIndicatorCode; + modeOfTransportCode?: ModeOfTransportCode; +} +export namespace TransportEquipmentEvent { + export type EventTypeEnum = 'TRANSPORTEQUIPMENT'; + export const EventTypeEnum = { + TRANSPORTEQUIPMENT: 'TRANSPORTEQUIPMENT' as EventTypeEnum + }; +} \ No newline at end of file diff --git a/lib/freight/ts/transportEvent.ts b/lib/freight/ts/transportEvent.ts new file mode 100644 index 0000000..f5bc59f --- /dev/null +++ b/lib/freight/ts/transportEvent.ts @@ -0,0 +1,33 @@ + +import { Event } from './event'; +import { EventClassifierCode } from './eventClassifierCode'; +import { EventDateTime } from './eventDateTime'; +import { EventID } from './eventID'; +import { EventTypeCode } from './eventTypeCode'; +import { FacilityCode } from './facilityCode'; +import { FacilityTypeCode } from './facilityTypeCode'; +import { ModeOfTransportCode } from './modeOfTransportCode'; +import { OtherFacility } from './otherFacility'; +import { TransportLegReference } from './transportLegReference'; +import { TransportReference } from './transportReference'; +import { UNLocationCode } from './uNLocationCode'; + +/** + * The transport event entity is a specialization of the event entity to support specification of data that only applies to a transport event. + */ +export interface TransportEvent extends Event { + eventType?: TransportEvent.EventTypeEnum; + transportReference: TransportReference; + transportLegReference: TransportLegReference; + facilityTypeCode: FacilityTypeCode; + uNLocationCode: UNLocationCode; + facilityCode: FacilityCode; + otherFacility?: OtherFacility; + modeOfTransportCode?: ModeOfTransportCode; +} +export namespace TransportEvent { + export type EventTypeEnum = 'TRANSPORT'; + export const EventTypeEnum = { + TRANSPORT: 'TRANSPORT' as EventTypeEnum + }; +} \ No newline at end of file diff --git a/lib/freight/ts/transportLegReference.ts b/lib/freight/ts/transportLegReference.ts new file mode 100644 index 0000000..255491a --- /dev/null +++ b/lib/freight/ts/transportLegReference.ts @@ -0,0 +1,6 @@ + + +/** + * The transport leg reference will be specific per mode of transport: - Vessel: Voyage number as specified by the vessel operator - Truck: Not yet specified - Rail: Not yet specified - Barge: Not yet specified. + */ +export type TransportLegReference = string; \ No newline at end of file diff --git a/lib/freight/ts/transportReference.ts b/lib/freight/ts/transportReference.ts new file mode 100644 index 0000000..60041e5 --- /dev/null +++ b/lib/freight/ts/transportReference.ts @@ -0,0 +1,6 @@ + + +/** + * The reference for the transport, e.g. when the mode of transport is a vessel, the transport reference will be the vessel IMO number. + */ +export type TransportReference = string; \ No newline at end of file diff --git a/lib/freight/ts/uNLocationCode.ts b/lib/freight/ts/uNLocationCode.ts new file mode 100644 index 0000000..b3a7173 --- /dev/null +++ b/lib/freight/ts/uNLocationCode.ts @@ -0,0 +1,6 @@ + + +/** + * The UN Location Code identifies a location in the sense of a city/a town/a village, being the smaller administrative area existing as defined by the competent national authority in each country. + */ +export type UNLocationCode = string; \ No newline at end of file diff --git a/system/cascadingSchemes.yaml b/system/cascadingSchemes.yaml new file mode 100644 index 0000000..d108027 --- /dev/null +++ b/system/cascadingSchemes.yaml @@ -0,0 +1,23 @@ +swagger: '2.0' +info: + version: 1.0.9-abcd + title: 'Swagger Sample API' + description: 'A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification' + termsOfService: 'http://helloreverb.com/terms/' + contact: {name: 'wordnik api team', url: 'http://developer.wordnik.com'} + license: {name: 'Creative Commons 4.0 International', url: 'http://creativecommons.org/licenses/by/4.0/'} +host: my.api.com +basePath: /v1 +schemes: + - http + - https +consumes: + - application/json +produces: + - application/json + - application/xml +paths: + '/pets/{petId}': {get: {description: 'Returns a pet based on ID', summary: 'Find pet by ID', operationId: getPetsById, produces: [application/json, text/html], parameters: [{name: petId, in: path, description: 'ID of pet that needs to be fetched', required: true, type: array, items: {type: string}, collectionFormat: csv}], responses: {'200': {description: 'pet response', schema: {$ref: Pet}}, default: {description: 'error payload', schema: {$ref: ErrorModel}}}, schemes: [https]}} +definitions: + Pet: {required: [name], properties: {name: {type: string}, tag: {type: string}}} + ErrorModel: {required: [code, message], properties: {code: {type: integer, format: int32}, message: {type: string}}} diff --git a/system/commonParameters.yaml b/system/commonParameters.yaml new file mode 100644 index 0000000..9851b74 --- /dev/null +++ b/system/commonParameters.yaml @@ -0,0 +1,23 @@ +swagger: '2.0' +info: + version: 1.0.9-abcd + title: 'Swagger Sample API' + description: 'A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification' + termsOfService: 'http://helloreverb.com/terms/' + contact: {name: 'wordnik api team', url: 'http://developer.wordnik.com'} + license: {name: 'Creative Commons 4.0 International', url: 'http://creativecommons.org/licenses/by/4.0/'} +host: my.api.com +basePath: /v1 +schemes: + - http + - https +consumes: + - application/json +produces: + - application/json + - application/xml +paths: + '/pets/{id}': {parameters: [{name: id, in: path, description: 'ID of pet to use', required: true, type: array, items: {type: string}, collectionFormat: csv}], get: {description: 'Returns pets based on ID', summary: 'Find pets by ID', operationId: getPetsById, produces: [application/json, text/html], responses: {'200': {description: 'pet response', schema: {type: array, items: {$ref: Pet}}}, default: {description: 'error payload', schema: {$ref: ErrorModel}}}}} +definitions: + Pet: {required: [name], properties: {name: {type: string}, tag: {type: string}}} + ErrorModel: {required: [code, message], properties: {code: {type: integer, format: int32}, message: {type: string}}} diff --git a/system/multipleMimeTypes.yaml b/system/multipleMimeTypes.yaml new file mode 100644 index 0000000..23bdc2d --- /dev/null +++ b/system/multipleMimeTypes.yaml @@ -0,0 +1,32 @@ +swagger: '2.0' +info: + version: 1.0.9-abcd + title: 'Swagger Sample API' + description: 'A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification' + termsOfService: 'http://helloreverb.com/terms/' + contact: {name: 'wordnik api team', url: 'http://developer.wordnik.com'} + license: {name: 'Creative Commons 4.0 International', url: 'http://creativecommons.org/licenses/by/4.0/'} +host: my.api.com +basePath: /v1 +schemes: + - http + - https +consumes: + - 'text/plain; charset=utf-8' + - application/json + - application/vnd.github+json + - application/vnd.github.v3+json + - application/vnd.github.v3.raw+json + - application/vnd.github.v3.text+json + - application/vnd.github.v3.html+json + - application/vnd.github.v3.full+json + - application/vnd.github.v3.diff + - application/vnd.github.v3.patch +produces: + - application/json + - application/xml +paths: + '/pets/{id}': {parameters: [{name: id, in: path, description: 'ID of pet to use', required: true, type: array, items: {type: string}, collectionFormat: csv}], get: {description: 'Returns pets based on ID', summary: 'Find pets by ID', operationId: getPetsById, produces: [application/json, text/html], responses: {'200': {description: 'pet response', schema: {type: array, items: {$ref: Pet}}}, default: {description: 'error payload', schema: {$ref: ErrorModel}}}}} +definitions: + Pet: {required: [name], properties: {name: {type: string}, tag: {type: string}}} + ErrorModel: {required: [code, message], properties: {code: {type: integer, format: int32}, message: {type: string}}} diff --git a/system/operations/operationWithTags.yaml b/system/operations/operationWithTags.yaml new file mode 100644 index 0000000..a3c85b2 --- /dev/null +++ b/system/operations/operationWithTags.yaml @@ -0,0 +1,14 @@ +description: 'Returns a pet based on ID' +summary: 'Find pet by ID' +operationId: getPetsById +tags: + - foo + - bar +produces: + - application/json + - text/html +parameters: + - {name: petId, in: path, description: 'ID of pet that needs to be fetched', required: true, type: integer, format: int64} +responses: + '200': {description: 'a pet to be returned', schema: {$ref: Pet}} + default: {description: 'Unexpected error', schema: {$ref: ErrorModel}} diff --git a/system/operations/stringPathAndBoolQueryParamResource.yaml b/system/operations/stringPathAndBoolQueryParamResource.yaml new file mode 100644 index 0000000..a00b8c4 --- /dev/null +++ b/system/operations/stringPathAndBoolQueryParamResource.yaml @@ -0,0 +1,12 @@ +description: 'Returns a pet based on ID' +summary: 'Find pet by ID' +operationId: getPetsById +produces: + - application/json + - text/html +parameters: + - {name: petId, in: path, description: 'ID of pet that needs to be fetched', required: true, type: integer, format: int64} + - {name: includeDetails, in: query, description: 'include details in response', required: true, type: boolean} +responses: + '200': {description: 'a pet to be returned', schema: {$ref: Pet}} + default: {description: 'Unexpected error', schema: {$ref: ErrorModel}} diff --git a/system/operations/stringPathParamResource.yaml b/system/operations/stringPathParamResource.yaml new file mode 100644 index 0000000..8c46cc7 --- /dev/null +++ b/system/operations/stringPathParamResource.yaml @@ -0,0 +1,12 @@ +description: 'Returns a pet based on ID' +summary: 'Find pet by ID' +operationId: getPetsById +produces: + - application/json + - text/html +parameters: + - {name: petId, in: path, description: 'ID of pet that needs to be fetched', required: true, type: integer, format: int64} +responses: + '200': {description: fun, schema: {$ref: Pet}} + '400': {description: 'Invalid ID supplied <= this is purely for documentation', schema: {$ref: ErrorModel}} + default: {description: 'Unexpected error', schema: {$ref: ErrorModel}} diff --git a/system/parameters/bodyComplexArrayParameter.yaml b/system/parameters/bodyComplexArrayParameter.yaml new file mode 100644 index 0000000..511f8dc --- /dev/null +++ b/system/parameters/bodyComplexArrayParameter.yaml @@ -0,0 +1,8 @@ +name: user +in: body +description: 'user to add to the system' +required: true +schema: + type: array + items: {type: string} + format: csv diff --git a/system/parameters/bodyComplexParameter.yaml b/system/parameters/bodyComplexParameter.yaml new file mode 100644 index 0000000..13f8fd1 --- /dev/null +++ b/system/parameters/bodyComplexParameter.yaml @@ -0,0 +1,6 @@ +name: user +in: body +description: 'user to add to the system' +required: true +schema: + $ref: User diff --git a/system/parameters/bodyInt64Parameter.yaml b/system/parameters/bodyInt64Parameter.yaml new file mode 100644 index 0000000..a270d94 --- /dev/null +++ b/system/parameters/bodyInt64Parameter.yaml @@ -0,0 +1,7 @@ +name: id +in: body +description: 'id to add' +required: true +schema: + type: integer + format: int64 diff --git a/system/parameters/bodyStringArrayParameter.yaml b/system/parameters/bodyStringArrayParameter.yaml new file mode 100644 index 0000000..7d88b10 --- /dev/null +++ b/system/parameters/bodyStringArrayParameter.yaml @@ -0,0 +1,7 @@ +name: user +in: body +description: 'user to add to the system' +required: true +schema: + type: array + items: {type: string} diff --git a/system/parameters/bodyStringParameter.yaml b/system/parameters/bodyStringParameter.yaml new file mode 100644 index 0000000..7fe9dbd --- /dev/null +++ b/system/parameters/bodyStringParameter.yaml @@ -0,0 +1,6 @@ +name: user +in: body +description: 'user to add to the system' +required: true +schema: + type: string diff --git a/system/parameters/formDataComplexParameter.yaml b/system/parameters/formDataComplexParameter.yaml new file mode 100644 index 0000000..b49dd9e --- /dev/null +++ b/system/parameters/formDataComplexParameter.yaml @@ -0,0 +1,5 @@ +name: firstName +in: formData +description: 'users first name' +required: true +$ref: Nothing diff --git a/system/parameters/formDataInt64Parameter.yaml b/system/parameters/formDataInt64Parameter.yaml new file mode 100644 index 0000000..0faaa7f --- /dev/null +++ b/system/parameters/formDataInt64Parameter.yaml @@ -0,0 +1,6 @@ +name: id +in: formData +description: 'username to fetch' +required: true +type: integer +format: int64 diff --git a/system/parameters/formDataStringArrayParameter.yaml b/system/parameters/formDataStringArrayParameter.yaml new file mode 100644 index 0000000..f653466 --- /dev/null +++ b/system/parameters/formDataStringArrayParameter.yaml @@ -0,0 +1,7 @@ +name: user +in: formData +description: 'user to add to the system' +required: true +type: array +items: + type: string diff --git a/system/parameters/formDataStringParameter.yaml b/system/parameters/formDataStringParameter.yaml new file mode 100644 index 0000000..43411cf --- /dev/null +++ b/system/parameters/formDataStringParameter.yaml @@ -0,0 +1,5 @@ +name: firstName +in: formData +description: 'users first name' +required: true +type: string diff --git a/system/parameters/headerInt64ArrayParameter.yaml b/system/parameters/headerInt64ArrayParameter.yaml new file mode 100644 index 0000000..87ec99c --- /dev/null +++ b/system/parameters/headerInt64ArrayParameter.yaml @@ -0,0 +1,9 @@ +name: token +in: header +description: 'token to be passed as a header' +required: true +type: array +items: + type: integer + format: int64 +collectionFormat: csv diff --git a/system/parameters/headerStringArrayParameter.yaml b/system/parameters/headerStringArrayParameter.yaml new file mode 100644 index 0000000..70e0a0a --- /dev/null +++ b/system/parameters/headerStringArrayParameter.yaml @@ -0,0 +1,8 @@ +name: token +in: header +description: 'token to be passed as a header' +required: true +type: array +items: + type: string +collectionFormat: csv diff --git a/system/parameters/headerStringParameter.yaml b/system/parameters/headerStringParameter.yaml new file mode 100644 index 0000000..ac99c2f --- /dev/null +++ b/system/parameters/headerStringParameter.yaml @@ -0,0 +1,5 @@ +name: token +in: header +description: 'token to be passed as a header' +required: true +type: string diff --git a/system/parameters/pathInt64Parameter.yaml b/system/parameters/pathInt64Parameter.yaml new file mode 100644 index 0000000..3bd860a --- /dev/null +++ b/system/parameters/pathInt64Parameter.yaml @@ -0,0 +1,6 @@ +name: id +in: path +description: 'username to fetch' +required: true +type: integer +format: int64 diff --git a/system/parameters/pathStringArrayParameter.yaml b/system/parameters/pathStringArrayParameter.yaml new file mode 100644 index 0000000..ebb24a7 --- /dev/null +++ b/system/parameters/pathStringArrayParameter.yaml @@ -0,0 +1,8 @@ +name: usernames +in: path +description: 'usernames to pass' +required: true +type: array +items: + type: string +collectionFormat: csv diff --git a/system/parameters/pathStringParameter.yaml b/system/parameters/pathStringParameter.yaml new file mode 100644 index 0000000..2cb4fb2 --- /dev/null +++ b/system/parameters/pathStringParameter.yaml @@ -0,0 +1,5 @@ +name: username +in: path +description: 'username to fetch' +required: true +type: string diff --git a/system/parameters/queryInt64ArrayParameter.yaml b/system/parameters/queryInt64ArrayParameter.yaml new file mode 100644 index 0000000..453e24f --- /dev/null +++ b/system/parameters/queryInt64ArrayParameter.yaml @@ -0,0 +1,9 @@ +name: id +in: query +description: 'ID of the object to fetch' +required: true +type: array +items: + type: integer + format: int64 +collectionFormat: csv diff --git a/system/parameters/queryStringParameter.yaml b/system/parameters/queryStringParameter.yaml new file mode 100644 index 0000000..e1df685 --- /dev/null +++ b/system/parameters/queryStringParameter.yaml @@ -0,0 +1,6 @@ +name: id +in: query +description: 'ID of the object to fetch' +required: true +type: integer +format: int64 diff --git a/system/parameters/queryWithComplexParameter.yaml b/system/parameters/queryWithComplexParameter.yaml new file mode 100644 index 0000000..80bc795 --- /dev/null +++ b/system/parameters/queryWithComplexParameter.yaml @@ -0,0 +1,6 @@ +name: id +in: query +description: 'a complex object which should not validate' +required: true +schema: + $ref: Pet diff --git a/system/resourceWithExamplePayload.yaml b/system/resourceWithExamplePayload.yaml new file mode 100644 index 0000000..9828d96 --- /dev/null +++ b/system/resourceWithExamplePayload.yaml @@ -0,0 +1,23 @@ +swagger: '2.0' +info: + version: 1.0.9-abcd + title: 'Swagger Sample API' + description: 'A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification' + termsOfService: 'http://helloreverb.com/terms/' + contact: {name: 'wordnik api team', url: 'http://developer.wordnik.com'} + license: {name: 'Creative Commons 4.0 International', url: 'http://creativecommons.org/licenses/by/4.0/'} +host: my.api.com +basePath: /v1 +schemes: + - http + - https +consumes: + - application/json +produces: + - application/json + - application/xml +paths: + '/pets/{petId}': {get: {description: 'Returns a pet based on ID', summary: 'Find pet by ID', operationId: getPetsById, produces: [application/json, text/html], parameters: [{name: petId, in: path, description: 'ID of pet that needs to be fetched', required: true, type: array, items: {type: string}, collectionFormat: csv}], responses: {'200': {description: 'pet response', schema: {$ref: Pet}, examples: {application/json: {id: 9, category: {name: domestic}, name: monster, tags: [{name: 'for sale'}], status: alive}}}, default: {description: 'error payload', schema: {$ref: ErrorModel}}}}} +definitions: + Pet: {required: [name], properties: {name: {type: string, example: cat}, tag: {type: string, example: 'for sale'}}} + ErrorModel: {required: [code, message], properties: {code: {type: integer, format: int32}, message: {type: string}}} diff --git a/system/resourceWithLinkedDefinitions.yaml b/system/resourceWithLinkedDefinitions.yaml new file mode 100644 index 0000000..b9b00c4 --- /dev/null +++ b/system/resourceWithLinkedDefinitions.yaml @@ -0,0 +1,23 @@ +swagger: '2.0' +info: + version: 1.0.9-abcd + title: 'Swagger Sample API' + description: 'A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification' + termsOfService: 'http://helloreverb.com/terms/' + contact: {name: 'wordnik api team', url: 'http://developer.wordnik.com'} + license: {name: 'Creative Commons 4.0 International', url: 'http://creativecommons.org/licenses/by/4.0/'} +host: my.api.com +basePath: /v1 +schemes: + - http + - https +consumes: + - application/json +produces: + - application/json + - application/xml +paths: + '/pets/{petId}': {$ref: 'https://raw.githubusercontent.com/reverb/swagger-spec/master/fixtures/v2.0/json/resources/resourceWithLinkedDefinitions_part1.json'} +definitions: + Pet: {required: [name], properties: {name: {type: string}, tag: {type: string}}} + ErrorModel: {required: [code, message], properties: {code: {type: integer, format: int32}, message: {type: string}}} diff --git a/system/resourceWithLinkedDefinitions_part1.yaml b/system/resourceWithLinkedDefinitions_part1.yaml new file mode 100644 index 0000000..7d358fb --- /dev/null +++ b/system/resourceWithLinkedDefinitions_part1.yaml @@ -0,0 +1,7 @@ +get: + description: 'Returns a pet based on ID' + summary: 'Find pet by ID' + operationId: getPetsById + produces: [application/json, text/html] + parameters: [{name: petId, in: path, description: 'ID of pet that needs to be fetched', required: true, type: array, items: {type: string}, collectionFormat: csv}] + responses: {'200': {description: 'pet response', schema: {$ref: Pet}}, default: {description: 'error payload', schema: {$ref: ErrorModel}}} diff --git a/system/resourceWithRelativeHost.yaml b/system/resourceWithRelativeHost.yaml new file mode 100644 index 0000000..744aa72 --- /dev/null +++ b/system/resourceWithRelativeHost.yaml @@ -0,0 +1,22 @@ +swagger: '2.0' +info: + version: 1.0.9-abcd + title: 'Swagger Sample API' + description: 'A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification' + termsOfService: 'http://helloreverb.com/terms/' + contact: {name: 'wordnik api team', url: 'http://developer.wordnik.com'} + license: {name: 'Creative Commons 4.0 International', url: 'http://creativecommons.org/licenses/by/4.0/'} +basePath: /v1 +schemes: + - http + - https +consumes: + - application/json +produces: + - application/json + - application/xml +paths: + '/pets/{id}': {parameters: [{name: id, in: path, description: 'ID of pet to use', required: true, type: array, items: {type: string}, collectionFormat: csv}], get: {description: 'Returns pets based on ID', summary: 'Find pets by ID', operationId: getPetsById, produces: [application/json, text/html], responses: {'200': {description: 'pet response', schema: {type: array, items: {$ref: Pet}}}, default: {description: 'error payload', schema: {$ref: ErrorModel}}}}} +definitions: + Pet: {required: [name], properties: {name: {type: string}, tag: {type: string}}} + ErrorModel: {required: [code, message], properties: {code: {type: integer, format: int32}, message: {type: string}}} diff --git a/system/reusableParameters.yaml b/system/reusableParameters.yaml new file mode 100644 index 0000000..1d258d0 --- /dev/null +++ b/system/reusableParameters.yaml @@ -0,0 +1,26 @@ +swagger: '2.0' +info: + version: 1.0.9-abcd + title: 'Swagger Sample API' + description: 'A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification' + termsOfService: 'http://helloreverb.com/terms/' + contact: {name: 'wordnik api team', url: 'http://developer.wordnik.com'} + license: {name: 'Creative Commons 4.0 International', url: 'http://creativecommons.org/licenses/by/4.0/'} +host: my.api.com +basePath: /v1 +schemes: + - http + - https +consumes: + - application/json +produces: + - application/json + - application/xml +paths: + '/pets/{id}': {get: {description: 'Returns pets based on ID', summary: 'Find pets by ID', operationId: getPetsById, parameters: [{$ref: '#/parameters/skipParam'}, {$ref: '#/parameters/limitParam'}], responses: {'200': {description: 'pet response', schema: {type: array, items: {$ref: Pet}}}, default: {description: 'error payload', schema: {$ref: ErrorModel}}}}} +parameters: + skipParam: {name: skip, in: query, description: 'number of items to skip', required: true, type: integer, format: int32} + limitParam: {name: limit, in: query, description: 'max records to return', required: true, type: integer, format: int32} +definitions: + Pet: {required: [name], properties: {name: {type: string}, tag: {type: string}}} + ErrorModel: {required: [code, message], properties: {code: {type: integer, format: int32}, message: {type: string}}} diff --git a/system/securityExample.yaml b/system/securityExample.yaml new file mode 100644 index 0000000..007d26d --- /dev/null +++ b/system/securityExample.yaml @@ -0,0 +1,29 @@ +swagger: '2.0' +info: + version: 1.0.9-abcd + title: 'Swagger Sample API' + description: 'A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification' + termsOfService: 'http://helloreverb.com/terms/' + contact: {name: 'wordnik api team', url: 'http://developer.wordnik.com'} + license: {name: 'Creative Commons 4.0 International', url: 'http://creativecommons.org/licenses/by/4.0/'} +basePath: /v1 +schemes: + - http + - https +consumes: + - application/json +produces: + - application/json + - application/xml +security: + - {githubAccessCode: [user, gist]} + - {internalApiKey: []} +paths: + '/pets/{id}': {parameters: [{name: id, in: path, description: 'ID of pet to use', required: true, type: array, items: {type: string}, collectionFormat: csv}], get: {description: 'Returns pets based on ID', summary: 'Find pets by ID', operationId: getPetsById, security: [{githubAuth: ['user:read', 'user:write']}, {internalApiKey: []}], produces: [application/json, text/html], responses: {'200': {description: 'pet response', schema: {type: array, items: {$ref: Pet}}}, default: {description: 'error payload', schema: {$ref: ErrorModel}}}}} +securityDefinitions: + githubAccessCode: {type: oauth2, scopes: {user: 'Grants read/write access to profile info only. Note that this scope includes user:email and user:follow.', 'user:email': 'Grants read access to a user’s email addresses.', 'user:follow': 'Grants access to follow or unfollow other users.', public_repo: 'Grants read/write access to code, commit statuses, and deployment statuses for public repositories and organizations.', repo: 'Grants read/write access to code, commit statuses, and deployment statuses for public and private repositories and organizations.', repo_deployment: 'Grants access to deployment statuses for public and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, without granting access to the code.', 'repo:status': 'Grants read/write access to public and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses without granting access to the code.', delete_repo: 'Grants access to delete adminable repositories.', notifications: 'Grants read access to a user’s notifications. repo also provides this access.', gist: 'Grants write access to gists.', 'read:repo_hook': 'Grants read and ping access to hooks in public or private repositories.', 'write:repo_hook': 'Grants read, write, and ping access to hooks in public or private repositories.', 'admin:repo_hook': 'Grants read, write, ping, and delete access to hooks in public or private repositories.', 'read:org': 'Read-only access to organization, teams, and membership.', 'write:org': 'Publicize and unpublicize organization membership.', 'admin:org': 'Fully manage organization, teams, and memberships.', 'read:public_key': 'List and view details for public keys.', 'write:public_key': 'Create, list, and view details for public keys.', 'admin:public_key': 'Fully manage public keys.'}, flow: accessCode, authorizationUrl: 'https://github.com/login/oauth/authorize', tokenUrl: 'https://github.com/login/oauth/access_token'} + petstoreImplicit: {type: oauth2, scopes: {user: 'Grants read/write access to profile info only. Note that this scope includes user:email and user:follow.', 'user:email': 'Grants read access to a user’s email addresses.', 'user:follow': 'Grants access to follow or unfollow other users.', public_repo: 'Grants read/write access to code, commit statuses, and deployment statuses for public repositories and organizations.', repo: 'Grants read/write access to code, commit statuses, and deployment statuses for public and private repositories and organizations.', repo_deployment: 'Grants access to deployment statuses for public and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, without granting access to the code.', 'repo:status': 'Grants read/write access to public and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses without granting access to the code.', delete_repo: 'Grants access to delete adminable repositories.', notifications: 'Grants read access to a user’s notifications. repo also provides this access.', gist: 'Grants write access to gists.', 'read:repo_hook': 'Grants read and ping access to hooks in public or private repositories.', 'write:repo_hook': 'Grants read, write, and ping access to hooks in public or private repositories.', 'admin:repo_hook': 'Grants read, write, ping, and delete access to hooks in public or private repositories.', 'read:org': 'Read-only access to organization, teams, and membership.', 'write:org': 'Publicize and unpublicize organization membership.', 'admin:org': 'Fully manage organization, teams, and memberships.', 'read:public_key': 'List and view details for public keys.', 'write:public_key': 'Create, list, and view details for public keys.', 'admin:public_key': 'Fully manage public keys.'}, flow: implicit, authorizationUrl: 'http://petstore.swagger.wordnik.com/oauth/dialog'} + internalApiKey: {type: apiKey, in: header, name: api_key} +definitions: + Pet: {required: [name], properties: {name: {type: string}, tag: {type: string}}} + ErrorModel: {required: [code, message], properties: {code: {type: integer, format: int32}, message: {type: string}}} diff --git a/system/stringPathParamResource.yaml b/system/stringPathParamResource.yaml new file mode 100644 index 0000000..a4a83fe --- /dev/null +++ b/system/stringPathParamResource.yaml @@ -0,0 +1,23 @@ +swagger: '2.0' +info: + version: 1.0.9-abcd + title: 'Swagger Sample API' + description: 'A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification' + termsOfService: 'http://helloreverb.com/terms/' + contact: {name: 'wordnik api team', url: 'http://developer.wordnik.com'} + license: {name: 'Creative Commons 4.0 International', url: 'http://creativecommons.org/licenses/by/4.0/'} +host: my.api.com +basePath: /v1 +schemes: + - http + - https +consumes: + - application/json +produces: + - application/json + - application/xml +paths: + '/pets/{petId}': {get: {description: 'Returns a pet based on ID', summary: 'Find pet by ID', operationId: getPetsById, produces: [application/json, text/html], parameters: [{name: petId, in: path, description: 'ID of pet that needs to be fetched', required: true, type: array, items: {type: string}, collectionFormat: csv}], responses: {'200': {description: 'pet response', schema: {$ref: Pet}}, default: {description: 'error payload', schema: {$ref: ErrorModel}}}}} +definitions: + Pet: {required: [name], properties: {name: {type: string}, tag: {type: string}}} + ErrorModel: {required: [code, message], properties: {code: {type: integer, format: int32}, message: {type: string}}} diff --git a/system/taggedResource.yaml b/system/taggedResource.yaml new file mode 100644 index 0000000..1b8620e --- /dev/null +++ b/system/taggedResource.yaml @@ -0,0 +1,29 @@ +swagger: '2.0' +x-reverb: + addAnythingYouWant: true +info: + x-reverb-info: 'this is an example' + version: 1.0.9-abcd + title: 'Swagger Sample API' + description: 'A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification' + termsOfService: 'http://helloreverb.com/terms/' + contact: {name: 'wordnik api team', url: 'http://developer.wordnik.com'} + license: {name: 'Creative Commons 4.0 International', url: 'http://creativecommons.org/licenses/by/4.0/'} +host: my.api.com +basePath: /v1 +schemes: + - http + - https +consumes: + - application/json +produces: + - application/json + - application/xml +tags: + - {name: pets} +paths: + x-reverb-path-info: 'vendor info' + /pets: {x-vendor-method: {}, get: {x-vendor-operation-property: {}, description: 'Returns a pet based on ID', summary: 'Find pet by ID', operationId: getPetsById, produces: [application/json, text/html], parameters: [{x-vendor-parameter-property: {}, name: petId, in: path, description: 'ID of pet that needs to be fetched', required: true, type: array, items: {type: string}, collectionFormat: csv}], responses: {'200': {description: 'pet response', schema: {$ref: Pet}}, x-vendor-operation-response-property: {}, default: {description: 'error payload', schema: {$ref: ErrorModel}}}}} +definitions: + Pet: {x-vendor-model-property: {}, required: [name], properties: {name: {type: string}, tag: {type: string}}} + ErrorModel: {required: [code, message], properties: {code: {type: integer, format: int32}, message: {type: string}}} diff --git a/system/vendorExtensionExamples.yaml b/system/vendorExtensionExamples.yaml new file mode 100644 index 0000000..59bba0f --- /dev/null +++ b/system/vendorExtensionExamples.yaml @@ -0,0 +1,27 @@ +swagger: '2.0' +x-reverb: + addAnythingYouWant: true +info: + x-reverb-info: 'this is an example' + version: 1.0.9-abcd + title: 'Swagger Sample API' + description: 'A sample API that uses a petstore as an example to demonstrate features in the swagger-2.0 specification' + termsOfService: 'http://helloreverb.com/terms/' + contact: {name: 'wordnik api team', url: 'http://developer.wordnik.com'} + license: {name: 'Creative Commons 4.0 International', url: 'http://creativecommons.org/licenses/by/4.0/'} +host: my.api.com +basePath: /v1 +schemes: + - http + - https +consumes: + - application/json +produces: + - application/json + - application/xml +paths: + x-reverb-path-info: 'vendor info' + /pets: {x-vendor-method: {}, get: {x-vendor-operation-property: {}, description: 'Returns a pet based on ID', summary: 'Find pet by ID', operationId: getPetsById, produces: [application/json, text/html], parameters: [{x-vendor-parameter-property: {}, name: petId, in: path, description: 'ID of pet that needs to be fetched', required: true, type: array, items: {type: string}, collectionFormat: csv}], responses: {'200': {description: 'pet response', schema: {$ref: Pet}}, x-vendor-operation-response-property: {}, default: {description: 'error payload', schema: {$ref: ErrorModel}}}}} +definitions: + Pet: {x-vendor-model-property: {}, required: [name], properties: {name: {type: string}, tag: {type: string}}} + ErrorModel: {required: [code, message], properties: {code: {type: integer, format: int32}, message: {type: string}}} diff --git a/trading_channel_credentials.jsonld b/trading_channel_credentials.jsonld new file mode 100644 index 0000000..27e0d1a --- /dev/null +++ b/trading_channel_credentials.jsonld @@ -0,0 +1,48 @@ +{ + + "@context": [ + "https://www.w3.org/2018/credentials/v1", + "https://www.w3.org/2018/credentials/examples/v1" + ], + + "id": "http://example.edu/credentials/1872", + + "type": ["VerifiableCredential", "TradingChannelCredential"], + + "issuer": "https://example.edu/issuers/565049", + + "issuanceDate": "2020-01-01T19:73:24Z", + + "credentialSubject": { + + "id": "did:example:ebfeb1f712ebc6f1c276e12ec21", + + "tradingChannelOf": { + "id": "did:example:c276e12ec21ebfeb1f712ebc6f1", + "name": [{ + "value": "Example", + "lang": "en" + }, { + "value": "Exemple", + "lang": "fr" + }] + } + }, + + + "proof": { + + "type": "RsaSignature2018", + + "created": "2017-06-18T21:19:10Z", + + "proofPurpose": "assertionMethod", + + "verificationMethod": "https://example.edu/issuers/keys/1", + + "jws": "eyJhbGciOiJSUzI1NiIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..TCYt5X + sITJX1CxPCT8yAV-TVkIEq_PbChOMqsLfRoPsnsgw5WEuts01mq-pQy7UJiN5mgRxD-WUc + X16dUEMGlv50aqzpqh4Qktb3rk-BuQy72IFLOqV0G_zS245-kronKb78cPN25DGlcTwLtj + PAYuNzVBAh4vGHSrQyHUdBBPM" + } +} \ No newline at end of file