generated: '2026-09-04'
method: derived
source: >-
  openapi/xcures-patient-registry-api-openapi.yml (in-spec examples) and
  https://docs.xcures.com/downloads/xCures_SDK_Workflows.postman_collection.json (fetched verbatim)
api: xCures Public API
summary: >-
  xCures ships example values densely at the SCHEMA-PROPERTY level and almost not at all at the
  RESPONSE-BODY level. 361 `example` keys appear in the 290KB contract; 170 of them sit directly on top-level schema
  properties (Subject.firstName "David", Subject.addressState "MN", Application.birthDate "2023-05-26",
  ids as real-shaped UUIDs) and the rest are nested inside those schemas. Only 12 example bodies are
  attached at the response level across 69 operations — the v2 subject-create 409 ProblemDetails is the
  clearest one. So a generated
  client gets realistic field-level values but a developer gets few complete request/response pairs FROM
  THE SPEC. The gap is filled outside the spec, and well: the Postman collection carries 75+ executable
  requests wired end to end, and the Redocly reference renders code samples in eight languages.
in_spec:
  example_keys: 361
  examples_keys: 1
  schema_property_examples: 170
  response_level_examples: 12
  level: predominantly schema-property
  media_type_examples: sparse
  notable:
    - operation: PublicSubjectControllerV2_create
      status: 409
      example: '{ "title": "Conflict", "status": 409, "detail": "<details about the conflict>" }'
      note: the only worked error-body example in the contract
  code_samples:
    rendered_by: Redocly API Hub reference
    languages: [cURL, JavaScript, Python, Node.js, Java, PHP, C#, Ruby]
    url: https://docs.xcures.com/apis/current
    note: >-
      Generated by the docs platform from the spec, not authored by xCures — they are correct but they
      are not hand-written examples.
executable_examples:
  - name: xCures SDK — Workflow Playbook
    type: postman-collection
    file: xcures-workflow-playbook.postman_collection.json
    url: https://docs.xcures.com/downloads/xCures_SDK_Workflows.postman_collection.json
    http_status: 200
    method: searched
    requests: 75+
    folders:
      - 0 — Auth (run first)
      - 1 — Your First Call
      - 2 — Patient Creation
      - 3 — Patient Creation & Query
      - 4 — Standard Treatment Workflow
      - 5 — List Subjects
      - 6 — Document Count
      - 7 — Document Download
      - 8 — Upload Documents
      - 9 — FHIR Resources
      - 10 — Clinical Concepts — all 15 types
    chaining: >-
      Step 0.1 runs the client-credentials exchange and saves the token to {{bearer_token}}; each
      subsequent step saves the ids the next step needs, so folders run top to bottom.
    credentials_included: false
    note: >-
      Saved verbatim. Contains no credentials — client_id, client_secret and project_id are empty
      collection variables the integrator fills in.
  - name: Published workflow walkthroughs
    type: documentation
    url: https://docs.xcures.com/api-introduction
    method: searched
    note: >-
      Six end-to-end workflow diagrams (standard treatment, BYOD, retrieval only, requery, bulk
      onboarding, reciprocity) with per-step annotations and cURL examples for the auth and project calls.
  - name: Agent Skills
    type: agent-skill
    url: https://docs.xcures.com/.well-known/agent-skills/index.json
    method: searched
    files: ../skills/
    note: >-
      The same six workflows expressed as machine-readable step lists with literal method + path strings.
      For an agent these are the executable examples.