{ "$schema": "http://json-schema.org/draft-04/schema#", "title": "AgreementData", "type": "object", "description": "Szczególy umowy\nSchema: https://api.nfz.gov.pl/app-umw-api/schemas/#agreement-data", "additionalProperties": false, "properties": { "agreement": { "description": "Umowa", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/Agreement" } ] }, "plans": { "type": [ "array", "null" ], "description": "Lista planów umowy", "items": { "$ref": "#/definitions/AgreementPlan" } }, "orthopedic-supplies": { "type": [ "array", "null" ], "description": "Lista środków ortopedycznych", "items": { "$ref": "#/definitions/OrthopedicSupply" } } }, "definitions": { "Agreement": { "type": "object", "description": "Szczegóły umowy podpisanej ze świadczeniodawcą\nSchema: https://api.nfz.gov.pl/app-umw-api/schemas/#agreement", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "Identyfikator umowy", "format": "guid" }, "type": { "type": [ "null", "string" ], "description": "Typ obiektu" }, "attributes": { "description": "Atrybuty umowy", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/AgreementAttributes" } ] }, "links": { "description": "Linki ", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/BaseLinks" } ] } } }, "AgreementAttributes": { "type": "object", "description": "Atrybuty umowy\nSchema: https://api.nfz.gov.pl/app-umw-api/schemas/#agreement-attributes", "additionalProperties": false, "properties": { "code": { "type": [ "null", "string" ], "description": "Kod umowy" }, "technical-code": { "type": [ "null", "string" ], "description": "Techniczny kod umowy przekazywany w ramach UMX, używany w ramach wymiany danych z NFZ" }, "origin-code": { "type": [ "null", "string" ], "description": "Kod pierwotny umowy" }, "service-type": { "type": [ "null", "string" ], "description": "Rodzaj świadczenia" }, "service-name": { "type": [ "null", "string" ], "description": "Nazwa rodzaju świadczenia" }, "amount": { "type": [ "null", "number" ], "description": "Kwota", "format": "decimal" }, "updated-at": { "type": "string", "description": "Data aktualizacji danych w centrali ", "format": "date-time" }, "provider-code": { "type": [ "null", "string" ], "description": "Kod świadczeniodawcy" }, "provider-nip": { "type": [ "null", "string" ], "description": "Numer NIP" }, "provider-regon": { "type": [ "null", "string" ], "description": "Numer REGON" }, "provider-registry-number": { "type": [ "null", "string" ], "description": "Numer księgi rejestrowej" }, "provider-name": { "type": [ "null", "string" ], "description": "Nazwa świadczeniodawcy" }, "provider-place": { "type": [ "null", "string" ], "description": "Miejscowość świadczeniodawcy" }, "year": { "type": "integer", "description": "Rok", "format": "int32" }, "branch": { "type": [ "null", "string" ], "description": "Oddział świadczeniodawcy" } } }, "BaseLinks": { "type": "object", "description": "Podstawowe linki nawigujące\nWięcej informacji: https://api.nfz.gov.pl/app-umw-api/#links", "additionalProperties": false, "properties": { "related": { "type": [ "null", "string" ], "description": "Link do zasobu powiązanego" } } }, "AgreementPlan": { "allOf": [ { "$ref": "#/definitions/AgreementPlanBase" }, { "type": "object", "description": "Szczegóły planu umowy\nSchema: https://api.nfz.gov.pl/app-umw-api/schemas/#agreement-plan", "additionalProperties": false, "properties": { "attributes": { "description": "Atrybuty planu umowy", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/AgreementPlanAttributes" } ] } } } ] }, "AgreementPlanAttributes": { "allOf": [ { "$ref": "#/definitions/AgreementPlanAttributesBase" }, { "type": "object", "description": "Atrybuty planu umowy\nSchema: https://api.nfz.gov.pl/app-umw-api/schemas/#agreement-plan-attributes", "additionalProperties": false, "properties": { "date-from": { "type": [ "null", "string" ], "description": "Data początku obowiązywania produktu kontraktowego w planie umowy", "format": "date-time" }, "date-to": { "type": [ "null", "string" ], "description": "Data końca obowiązywania produktu kontraktowego w planie umowy", "format": "date-time" } } } ] }, "AgreementPlanAttributesBase": { "type": "object", "description": "Atrybuty planu umowy\nSchema: https://api.nfz.gov.pl/app-umw-api/schemas/#agreement-plan-attributes", "additionalProperties": false, "properties": { "product-code": { "type": [ "null", "string" ], "description": "Kod produktu kontraktowego" }, "product-name": { "type": [ "null", "string" ], "description": "Nazwa produktu kontraktowego" }, "order": { "type": "integer", "description": "Wyróżnik produktu w planie umowy", "format": "int32" }, "unit-count": { "type": "number", "description": "Sumaryczna liczba kontraktu dla produktu", "format": "decimal" }, "price": { "type": "number", "description": "Sumaryczna kwota kontraktu dla produktu ", "format": "decimal" }, "avg-price": { "type": "number", "description": "Średnia cena produktu ", "format": "decimal" } } }, "AgreementPlanBase": { "type": "object", "description": "Szczegóły planu umowy\nSchema: https://api.nfz.gov.pl/app-umw-api/schemas/#agreement-plan", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "Identyfikator umowy", "format": "guid" }, "type": { "type": [ "null", "string" ], "description": "Typ obiektu" }, "attributes": { "description": "Atrybuty planu umowy", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/AgreementPlanAttributesBase" } ] }, "links": { "description": "Linki ", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/BaseLinks" } ] } } }, "OrthopedicSupply": { "type": "object", "description": "Szczegóły środka ortopedycznego\nSchema: https://api.nfz.gov.pl/app-umw-api/schemas/#orthopedic-supply", "additionalProperties": false, "properties": { "type": { "type": [ "null", "string" ], "description": "Typ obiektu" }, "attributes": { "description": "Atrybuty środka ortopedycznego", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/OrthopedicSupplyAttributes" } ] }, "links": { "description": "Linki ", "oneOf": [ { "type": "null" }, { "$ref": "#/definitions/BaseLinks" } ] } } }, "OrthopedicSupplyAttributes": { "type": "object", "description": "Atrybuty planu umowy\nSchema: https://api.nfz.gov.pl/app-umw-api/schemas/#orthopedic-supply-attributes", "additionalProperties": false, "properties": { "code": { "type": [ "null", "string" ], "description": "Kod środka ortopedycznego" }, "name": { "type": [ "null", "string" ], "description": "Nazwa środka ortopedycznego" } } } } }