Generated Narrative: CapabilityStatement plan-net-bulk-publish

Plan-Net Bulk Publish CapabilityStatement (Draft)

  • Implementation Guide Version: 2.0.0-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: application/fhir+json
  • Published on: 2026-10-29
  • Published by: HL7 International / Financial Management

Note to Implementers: FHIR Capabilities

Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.

SHALL Support the Following Implementation Guides

FHIR RESTful Capabilities

Mode: server

This CapabilityStatement describes a Bulk Publish Data Provider. GET [base]/$bulk-publish returns an application/json Bulk Publish manifest, which references published FHIR resource files in NDJSON. The operation may be hosted on an ordinary HTTP server and does not imply support for other FHIR RESTful interactions. The resource entries below identify the expected content of the published dataset, not searchable resources.

Summary of System-wide Operations
ConformanceOperationDocumentation
SHALL$bulk-publish

The Data Provider SHALL respond to HTTP GET [base]/$bulk-publish with a Bulk Publish manifest using application/json and provide the referenced files as specified by Bulk Data Access IG 4.0.0-ballot. The dataset SHOULD include applicable Plan-Net resources from the eight listed types, sufficient to preserve relevant directory relationships. This is a static or periodically updated publication; it does not initiate an asynchronous export.

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Endpointhttp://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint
HealthcareServicehttp://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService
InsurancePlanhttp://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan
Locationhttp://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location
Organizationhttp://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization
Additional supported profiles:
  Plan-Net Network
OrganizationAffiliationhttp://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation
Practitionerhttp://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner
PractitionerRolehttp://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole

Resource Conformance: unspecified Endpoint

Base System Profile
Plan-Net Endpoint
Profile Conformance
SHALL
Reference Policy

Interaction summary

    Documentation

    Published NDJSON files SHOULD contain Plan-Net conformant Endpoint resources when applicable. This entry describes dataset content, not support for resource-level REST interactions.

    Resource Conformance: unspecified HealthcareService

    Base System Profile
    Plan-Net HealthcareService
    Profile Conformance
    SHALL
    Reference Policy

    Interaction summary

      Documentation

      Published NDJSON files SHOULD contain Plan-Net conformant HealthcareService resources when applicable. This entry describes dataset content, not support for resource-level REST interactions.

      Resource Conformance: unspecified InsurancePlan

      Base System Profile
      Plan-Net InsurancePlan
      Profile Conformance
      SHALL
      Reference Policy

      Interaction summary

        Documentation

        Published NDJSON files SHOULD contain Plan-Net conformant InsurancePlan resources when applicable. This entry describes dataset content, not support for resource-level REST interactions.

        Resource Conformance: unspecified Location

        Base System Profile
        Plan-Net Location
        Profile Conformance
        SHALL
        Reference Policy

        Interaction summary

          Documentation

          Published NDJSON files SHOULD contain Plan-Net conformant Location resources when applicable. This entry describes dataset content, not support for resource-level REST interactions.

          Resource Conformance: unspecified Organization

          Base System Profile
          Plan-Net Organization
          Profile Conformance
          SHALL
          Reference Policy

          Supported Profiles

          Plan-Net Network

          Interaction summary

            Documentation

            Published Organization resources can conform to the Plan-Net Organization or Plan-Net Network profile. These entries describe dataset content, not support for resource-level REST interactions.

            Resource Conformance: unspecified OrganizationAffiliation

            Base System Profile
            Plan-Net OrganizationAffiliation
            Profile Conformance
            SHALL
            Reference Policy

            Interaction summary

              Documentation

              Published NDJSON files SHOULD contain Plan-Net conformant OrganizationAffiliation resources when applicable. This entry describes dataset content, not support for resource-level REST interactions.

              Resource Conformance: unspecified Practitioner

              Base System Profile
              Plan-Net Practitioner
              Profile Conformance
              SHALL
              Reference Policy

              Interaction summary

                Documentation

                Published NDJSON files SHOULD contain Plan-Net conformant Practitioner resources when applicable. This entry describes dataset content, not support for resource-level REST interactions.

                Resource Conformance: unspecified PractitionerRole

                Base System Profile
                Plan-Net PractitionerRole
                Profile Conformance
                SHALL
                Reference Policy

                Interaction summary

                  Documentation

                  Published NDJSON files SHOULD contain Plan-Net conformant PractitionerRole resources when applicable. This entry describes dataset content, not support for resource-level REST interactions.

                   <status value="draft"/> <experimental value="true"/> <date value="2026-10-29"/> <publisher value="HL7 International / Financial Management"/> <contact> <name value="HL7 International / Financial Management"/> <telecom> <system value="url"/> <value value="http://www.hl7.org/Special/committees/fm"/> </telecom> <telecom> <system value="email"/> <value value="fm@lists.HL7.org"/> </telecom> </contact> <description value="Draft requirements for a Plan-Net Data Provider supporting Bulk Publish using the Bulk Data Access IG 4.0.0-ballot. This artifact is intended to be reviewed and potentially replaced or aligned with a future Bulk Publish CapabilityStatement from the Bulk Data IG."/> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166"/> <code value="US"/> </coding> </jurisdiction> <purpose value="Document the Bulk Publish endpoint and expected published Plan-Net resource types without implying on-demand Bulk Export or support for ordinary FHIR RESTful resource interactions."/> <kind value="requirements"/> <fhirVersion value="4.0.1"/> <format value="application/fhir+json"/> <implementationGuide value="http://hl7.org/fhir/us/davinci-pdex-plan-net/ImplementationGuide/hl7.fhir.us.davinci-pdex-plan-net"/> <implementationGuide value="http://hl7.org/fhir/uv/bulkdata/ImplementationGuide/hl7.fhir.uv.bulkdata|4.0.0-ballot"/> <rest> <mode value="server"/> <documentation value="This CapabilityStatement describes a Bulk Publish Data Provider. GET [base]/$bulk-publish returns an application/json Bulk Publish manifest, which references published FHIR resource files in NDJSON. The operation may be hosted on an ordinary HTTP server and does not imply support for other FHIR RESTful interactions. The resource entries below identify the expected content of the published dataset, not searchable resources."/> <resource> <type value="Endpoint"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Endpoint"/> <documentation value="Published NDJSON files SHOULD contain Plan-Net conformant Endpoint resources when applicable. This entry describes dataset content, not support for resource-level REST interactions."/> </resource> <resource> <type value="HealthcareService"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-HealthcareService"/> <documentation value="Published NDJSON files SHOULD contain Plan-Net conformant HealthcareService resources when applicable. This entry describes dataset content, not support for resource-level REST interactions."/> </resource> <resource> <type value="InsurancePlan"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-InsurancePlan"/> <documentation value="Published NDJSON files SHOULD contain Plan-Net conformant InsurancePlan resources when applicable. This entry describes dataset content, not support for resource-level REST interactions."/> </resource> <resource> <type value="Location"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Location"/> <documentation value="Published NDJSON files SHOULD contain Plan-Net conformant Location resources when applicable. This entry describes dataset content, not support for resource-level REST interactions."/> </resource> <resource> <type value="Organization"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Organization"/> <supportedProfile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Network"/> <documentation value="Published Organization resources can conform to the Plan-Net Organization or Plan-Net Network profile. These entries describe dataset content, not support for resource-level REST interactions."/> </resource> <resource> <type value="OrganizationAffiliation"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-OrganizationAffiliation"/> <documentation value="Published NDJSON files SHOULD contain Plan-Net conformant OrganizationAffiliation resources when applicable. This entry describes dataset content, not support for resource-level REST interactions."/> </resource> <resource> <type value="Practitioner"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-Practitioner"/> <documentation value="Published NDJSON files SHOULD contain Plan-Net conformant Practitioner resources when applicable. This entry describes dataset content, not support for resource-level REST interactions."/> </resource> <resource> <type value="PractitionerRole"/> <profile value="http://hl7.org/fhir/us/davinci-pdex-plan-net/StructureDefinition/plannet-PractitionerRole"/> <documentation value="Published NDJSON files SHOULD contain Plan-Net conformant PractitionerRole resources when applicable. This entry describes dataset content, not support for resource-level REST interactions."/> </resource> <operation> <name value="bulk-publish"/> <definition value="http://hl7.org/fhir/uv/bulkdata/OperationDefinition/bulk-publish"/> <documentation value="The Data Provider SHALL respond to HTTP GET [base]/$bulk-publish with a Bulk Publish manifest using application/json and provide the referenced files as specified by Bulk Data Access IG 4.0.0-ballot. The dataset SHOULD include applicable Plan-Net resources from the eight listed types, sufficient to preserve relevant directory relationships. This is a static or periodically updated publication; it does not initiate an asynchronous export."/> </operation> </rest> </CapabilityStatement>