openapi: 3.2.0 info: title: Beneficiary Claims Data Metadata API description: 'The Beneficiary Claims Data API (BCDA) allows downloading of claims data in accordance with the FHIR Bulk Data Export specification. If you have a Client ID and Secret you can use this page to explore the API. To do this: 1. Click the green "Authorize" button below and enter your Client ID and secret in the Basic Authentication boxes. 2. Request a bearer token from /auth/token 3. Click the green "Authorize" button below and put "Bearer {YOUR_TOKEN}" in the bearer_token box. Until you click logout your token will be presented with every request made. To make requests click on the "Try it out" button for the desired endpoint.' contact: email: bcapi@cms.hhs.gov license: name: Public Domain url: https://github.com/CMSgov/bcda-app/blob/main/LICENSE.md version: 1.0.0 servers: [] tags: - name: metadata paths: /_version: get: tags: - metadata summary: Get API version description: Returns the version of the API that is currently running. Note that this endpoint is **not** prefixed with the base path (e.g. /api/v1). operationId: getVersion responses: '200': description: JSON object containing a version field content: application/json: schema: required: - version type: object properties: version: type: string x-go-name: Version /api/v1/metadata: get: tags: - metadata summary: Get metadata description: Returns metadata about the API. operationId: metadata responses: '200': description: FHIR CapabilityStatement in JSON format content: application/json: schema: $ref: '#/components/schemas/CapabilityStatement' /api/v2/metadata: get: tags: - metadata summary: Get metadata description: Returns metadata about the API. operationId: metadatav2 responses: '200': description: FHIR CapabilityStatement in JSON format content: application/json: schema: $ref: '#/components/schemas/CapabilityStatement' components: schemas: RestfulCapabilityModeCode_Value: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto ResourceVersionPolicyCode: description: See http://hl7.org/fhir/ValueSet/versioning-policy type: object title: How the system supports versioning for a resource. properties: extension: type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/ResourceVersionPolicyCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto Base64Binary: description: 'Auto-generated from StructureDefinition for base64Binary, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type base64Binary. See http://hl7.org/fhir/StructureDefinition/base64Binary' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: description: Primitive value for base64Binary type: array items: type: integer format: uint8 x-go-name: Value x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto CapabilityStatement_Rest_Security_Certificate: description: Certificates associated with security profiles type: object properties: blob: $ref: '#/components/schemas/Base64Binary' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension type: $ref: '#/components/schemas/MimeTypeCode' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto Identifier: description: 'Auto-generated from StructureDefinition for Identifier, last updated 2017-04-19T07:44:43.294+10:00. An identifier intended for computation. See http://hl7.org/fhir/StructureDefinition/Identifier' type: object properties: assigner: $ref: '#/components/schemas/Reference' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' period: $ref: '#/components/schemas/Period' system: $ref: '#/components/schemas/Uri' type: $ref: '#/components/schemas/CodeableConcept' use: $ref: '#/components/schemas/IdentifierUseCode' value: $ref: '#/components/schemas/String' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto IdentifierUseCode_Value: description: Primitive value for code type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto UnsignedInt: description: 'Auto-generated from StructureDefinition for unsignedInt, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type unsignedInt. See http://hl7.org/fhir/StructureDefinition/unsignedInt' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: description: Primitive value for unsignedInt type: integer format: uint32 x-go-name: Value x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto ReferenceHandlingPolicyCode_Value: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto Period: description: 'Auto-generated from StructureDefinition for Period, last updated 2017-04-19T07:44:43.294+10:00. Time range defined by start and end date/time. See http://hl7.org/fhir/StructureDefinition/Period' type: object properties: end: $ref: '#/components/schemas/DateTime' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' start: $ref: '#/components/schemas/DateTime' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto DateTime_Precision: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto isExtension_ValueX_Choice: type: object x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto CapabilityStatement_Rest_Security: description: Information about security of implementation type: object properties: certificate: type: array items: $ref: '#/components/schemas/CapabilityStatement_Rest_Security_Certificate' x-go-name: Certificate cors: type: boolean description: $ref: '#/components/schemas/String' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension service: description: OAuth | SMART-on-FHIR | NTLM | Basic | Kerberos | Certificates type: array items: $ref: '#/components/schemas/CodeableConcept' x-go-name: Service x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto SystemRestfulInteractionCode: description: http://hl7.org/fhir/ValueSet/system-restful-interaction type: object title: Operations supported by REST at the system level. properties: extension: type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/SystemRestfulInteractionCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto Id: description: 'Auto-generated from StructureDefinition for id, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type id. See http://hl7.org/fhir/StructureDefinition/id' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: description: Primitive value for id type: string x-go-name: Value x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto LanguageCode: description: 'This value set includes common codes from BCP-47 (http://tools.ietf.org/html/bcp47) See http://hl7.org/fhir/ValueSet/languages Note: For historical reasons, this does not use an enum to represent value.' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: description: Primitive value for code type: string x-go-name: Value x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto SystemRestfulInteractionCode_Value: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto CapabilityStatement_Implementation: description: If this describes a specific instance type: object properties: description: $ref: '#/components/schemas/String' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension url: $ref: '#/components/schemas/Uri' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto String: description: 'Auto-generated from StructureDefinition for string, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type string. See http://hl7.org/fhir/StructureDefinition/string' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: description: Primitive value for string type: string x-go-name: Value x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto ContactPointSystemCode: description: 'Telecommunications form for contact point See http://hl7.org/fhir/ValueSet/contact-point-system' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/ContactPointSystemCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto ContactPointUseCode: description: 'Use of contact point See http://hl7.org/fhir/ValueSet/contact-point-use' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/ContactPointUseCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto UsageContext: description: 'Auto-generated from StructureDefinition for UsageContext, last updated 2017-04-19T07:44:43.294+10:00. Describes the context of use for a conformance or knowledge resource. See http://hl7.org/fhir/StructureDefinition/UsageContext' type: object properties: code: $ref: '#/components/schemas/Coding' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/UsageContext_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/metadatatypes_go_proto CapabilityStatement_Messaging: description: If messaging is supported type: object properties: documentation: $ref: '#/components/schemas/String' endpoint: type: array items: $ref: '#/components/schemas/CapabilityStatement_Messaging_Endpoint' x-go-name: Endpoint event: type: array items: $ref: '#/components/schemas/CapabilityStatement_Messaging_Event' x-go-name: Event extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension reliable_cache: $ref: '#/components/schemas/UnsignedInt' supported_message: type: array items: $ref: '#/components/schemas/CapabilityStatement_Messaging_SupportedMessage' x-go-name: SupportedMessage x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto CapabilityStatement_Rest_Resource_SearchParam: description: Search parameters supported by implementation type: object properties: definition: $ref: '#/components/schemas/Uri' documentation: $ref: '#/components/schemas/String' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension name: $ref: '#/components/schemas/String' type: $ref: '#/components/schemas/SearchParamTypeCode' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto ContactPointSystemCode_Value: description: Primitive value for code type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto Meta: description: 'Auto-generated from StructureDefinition for Meta, last updated 2017-04-19T07:44:43.294+10:00. Metadata about a resource. See http://hl7.org/fhir/StructureDefinition/Meta' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' last_updated: $ref: '#/components/schemas/Instant' profile: description: Profiles this resource claims to conform to type: array items: $ref: '#/components/schemas/Uri' x-go-name: Profile security: description: Security Labels applied to this resource type: array items: $ref: '#/components/schemas/Coding' x-go-name: Security tag: description: Tags applied to this resource type: array items: $ref: '#/components/schemas/Coding' x-go-name: Tag version_id: $ref: '#/components/schemas/Id' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto Code: description: 'Auto-generated from StructureDefinition for code, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type code. See http://hl7.org/fhir/StructureDefinition/code' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: description: Primitive value for code type: string x-go-name: Value x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto CapabilityStatement_Rest: description: If the endpoint is a RESTful one type: object properties: compartment: description: Compartments served/used by system type: array items: $ref: '#/components/schemas/Uri' x-go-name: Compartment documentation: $ref: '#/components/schemas/String' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' interaction: type: array items: $ref: '#/components/schemas/CapabilityStatement_Rest_SystemInteraction' x-go-name: Interaction mode: $ref: '#/components/schemas/RestfulCapabilityModeCode' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension operation: type: array items: $ref: '#/components/schemas/CapabilityStatement_Rest_Operation' x-go-name: Operation resource: type: array items: $ref: '#/components/schemas/CapabilityStatement_Rest_Resource' x-go-name: Resource search_param: description: Search parameters for searching all resources type: array items: $ref: '#/components/schemas/CapabilityStatement_Rest_Resource_SearchParam' x-go-name: SearchParam security: $ref: '#/components/schemas/CapabilityStatement_Rest_Security' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto ContactPointUseCode_Value: description: Primitive value for code type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto Reference: description: 'A reference from one resource to another See https://www.hl7.org/fhir/datatypes.html#Reference' type: object properties: Reference: $ref: '#/components/schemas/isReference_Reference' display: $ref: '#/components/schemas/String' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' identifier: $ref: '#/components/schemas/Identifier' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto CapabilityStatement_Rest_Operation: description: Definition of an operation or a custom query type: object properties: definition: $ref: '#/components/schemas/Reference' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension name: $ref: '#/components/schemas/String' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto isContainedResource_OneofResource: type: object x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto ReferenceHandlingPolicyCode: description: See http://hl7.org/fhir/ValueSet/reference-handling-policy type: object title: A set of flags that defines how references are supported. properties: extension: type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/ReferenceHandlingPolicyCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto DocumentModeCode_Value: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto MessageSignificanceCategoryCode: description: See http://hl7.org/fhir/ValueSet/message-significance-category type: object title: The impact of the content of a message. properties: extension: type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/MessageSignificanceCategoryCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto PositiveInt: description: 'Auto-generated from StructureDefinition for positiveInt, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type positiveInt. See http://hl7.org/fhir/StructureDefinition/positiveInt' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: description: Primitive value for positiveInt type: integer format: uint32 x-go-name: Value x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto NarrativeStatusCode_Value: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto CapabilityStatement_Rest_Resource: description: Resource served on the REST interface type: object properties: conditional_create: type: boolean conditional_delete: $ref: '#/components/schemas/ConditionalDeleteStatusCode' conditional_read: $ref: '#/components/schemas/ConditionalReadStatusCode' conditional_update: type: boolean documentation: $ref: '#/components/schemas/Markdown' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' interaction: type: array items: $ref: '#/components/schemas/CapabilityStatement_Rest_Resource_ResourceInteraction' x-go-name: Interaction modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension profile: $ref: '#/components/schemas/Reference' read_history: type: boolean reference_policy: description: literal | logical | resolves | enforced | local type: array items: $ref: '#/components/schemas/ReferenceHandlingPolicyCode' x-go-name: ReferencePolicy search_include: description: _include values supported by the server type: array items: $ref: '#/components/schemas/String' x-go-name: SearchInclude search_param: type: array items: $ref: '#/components/schemas/CapabilityStatement_Rest_Resource_SearchParam' x-go-name: SearchParam search_rev_include: description: _revinclude values supported by the server type: array items: $ref: '#/components/schemas/String' x-go-name: SearchRevInclude type: $ref: '#/components/schemas/ResourceTypeCode' update_create: type: boolean versioning: $ref: '#/components/schemas/ResourceVersionPolicyCode' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto ConditionalReadStatusCode: description: See http://hl7.org/fhir/ValueSet/conditional-read-status type: object title: A code that indicates how the server supports conditional read. properties: extension: type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/ConditionalReadStatusCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto CapabilityStatement_Rest_SystemInteraction: type: object title: What operations are supported? properties: code: $ref: '#/components/schemas/SystemRestfulInteractionCode' documentation: $ref: '#/components/schemas/String' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto ConditionalDeleteStatusCode: description: See http://hl7.org/fhir/ValueSet/conditional-delete-status type: object title: A code that indicates how the server supports conditional delete. properties: extension: type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/ConditionalDeleteStatusCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto MimeTypeCode: description: See http://www.rfc-editor.org/bcp/bcp13.txt type: object title: Any valid MimeType. properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: description: Primitive value for code type: string x-go-name: Value x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto Extension_ValueX: description: Value of extension type: object properties: Choice: $ref: '#/components/schemas/isExtension_ValueX_Choice' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto EventCapabilityModeCode: description: See http://hl7.org/fhir/ValueSet/event-capability-mode type: object title: The mode of a message capability statement. properties: extension: type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/EventCapabilityModeCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto ConditionalReadStatusCode_Value: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto CapabilityStatement: description: 'Auto-generated from StructureDefinition for CapabilityStatement, last updated 2017-04-19T07:44:43.294+10:00. A statement of system capabilities. See http://hl7.org/fhir/StructureDefinition/CapabilityStatement' type: object properties: accept_unknown: $ref: '#/components/schemas/UnknownContentCodeCode' contact: description: Contact details for the publisher type: array items: $ref: '#/components/schemas/ContactDetail' x-go-name: Contact contained: description: Contained, inline Resources type: array items: $ref: '#/components/schemas/ContainedResource' x-go-name: Contained copyright: $ref: '#/components/schemas/Markdown' date: type: string description: $ref: '#/components/schemas/Markdown' document: type: array items: $ref: '#/components/schemas/CapabilityStatement_Document' x-go-name: Document experimental: type: boolean extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension fhir_version: $ref: '#/components/schemas/Id' format: description: formats supported (xml | json | ttl | mime type) type: array items: $ref: '#/components/schemas/MimeTypeCode' x-go-name: Format id: $ref: '#/components/schemas/Id' implementation: $ref: '#/components/schemas/CapabilityStatement_Implementation' implementation_guide: description: Implementation guides supported type: array items: $ref: '#/components/schemas/Uri' x-go-name: ImplementationGuide implicit_rules: $ref: '#/components/schemas/Uri' instantiates: description: Canonical URL of another capability statement this implements type: array items: $ref: '#/components/schemas/Uri' x-go-name: Instantiates jurisdiction: description: Intended jurisdiction for capability statement (if applicable) type: array items: $ref: '#/components/schemas/CodeableConcept' x-go-name: Jurisdiction kind: type: string language: $ref: '#/components/schemas/LanguageCode' messaging: type: array items: $ref: '#/components/schemas/CapabilityStatement_Messaging' x-go-name: Messaging meta: $ref: '#/components/schemas/Meta' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension name: $ref: '#/components/schemas/String' patch_format: description: Patch formats supported type: array items: $ref: '#/components/schemas/MimeTypeCode' x-go-name: PatchFormat profile: description: Profiles for use cases supported type: array items: $ref: '#/components/schemas/Reference' x-go-name: Profile publisher: type: string purpose: $ref: '#/components/schemas/Markdown' rest: type: array items: $ref: '#/components/schemas/CapabilityStatement_Rest' x-go-name: Rest software: $ref: '#/components/schemas/CapabilityStatement_Software' status: type: string text: $ref: '#/components/schemas/Narrative' title: $ref: '#/components/schemas/String' url: $ref: '#/components/schemas/Uri' use_context: description: Context the content is intended to support type: array items: $ref: '#/components/schemas/UsageContext' x-go-name: UseContext version: $ref: '#/components/schemas/String' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto DateTime: description: 'Auto-generated from StructureDefinition for dateTime, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type dateTime. See http://hl7.org/fhir/StructureDefinition/dateTime' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' precision: $ref: '#/components/schemas/DateTime_Precision' timezone: type: string x-go-name: Timezone value_us: description: Primitive value for dateTime type: integer format: int64 x-go-name: ValueUs x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto ContainedResource: type: object properties: OneofResource: $ref: '#/components/schemas/isContainedResource_OneofResource' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto SearchParamTypeCode_Value: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto MessageSignificanceCategoryCode_Value: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto ConditionalDeleteStatusCode_Value: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto Narrative: description: 'Auto-generated from StructureDefinition for Narrative, last updated 2017-04-19T07:44:43.294+10:00. A human-readable formatted text, including images. See http://hl7.org/fhir/StructureDefinition/Narrative' type: object properties: div: $ref: '#/components/schemas/Xhtml' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' status: $ref: '#/components/schemas/NarrativeStatusCode' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/metadatatypes_go_proto ResourceTypeCode_Value: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto Extension: description: 'Optional Extensions Element See https://www.hl7.org/fhir/datatypes.html#Extension' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' url: $ref: '#/components/schemas/Uri' value: $ref: '#/components/schemas/Extension_ValueX' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto TypeRestfulInteractionCode_Value: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto EventCapabilityModeCode_Value: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto ContactPoint: description: 'Auto-generated from StructureDefinition for ContactPoint, last updated 2017-04-19T07:44:43.294+10:00. Details of a Technology mediated contact point (phone, fax, email, etc.). See http://hl7.org/fhir/StructureDefinition/ContactPoint' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' period: $ref: '#/components/schemas/Period' rank: $ref: '#/components/schemas/PositiveInt' system: $ref: '#/components/schemas/ContactPointSystemCode' use: $ref: '#/components/schemas/ContactPointUseCode' value: $ref: '#/components/schemas/String' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto DocumentModeCode: description: See http://hl7.org/fhir/ValueSet/document-mode type: object title: Whether the application produces or consumes documents. properties: extension: type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/DocumentModeCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto CapabilityStatement_Software: description: Software that is covered by this capability statement type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension name: $ref: '#/components/schemas/String' release_date: type: string version: $ref: '#/components/schemas/String' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto Instant: description: 'Auto-generated from StructureDefinition for instant, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type instant. See http://hl7.org/fhir/StructureDefinition/instant' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' precision: $ref: '#/components/schemas/Instant_Precision' timezone: type: string x-go-name: Timezone value_us: description: Primitive value for instant type: integer format: int64 x-go-name: ValueUs x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto Markdown: description: 'Auto-generated from StructureDefinition for markdown, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type markdown. See http://hl7.org/fhir/StructureDefinition/markdown' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: description: Primitive value for markdown type: string x-go-name: Value x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto ResourceVersionPolicyCode_Value: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto IdentifierUseCode: description: See http://hl7.org/fhir/ValueSet/identifier-use type: object title: Identifies the purpose for this identifier, if known . properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/IdentifierUseCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto NarrativeStatusCode: description: 'The status of a resource narrative See http://hl7.org/fhir/ValueSet/narrative-status' type: object properties: extension: type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/NarrativeStatusCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto CapabilityStatement_Messaging_SupportedMessage: description: Messages supported by this system type: object properties: definition: $ref: '#/components/schemas/Reference' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' mode: $ref: '#/components/schemas/EventCapabilityModeCode' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto UnknownContentCodeCode_Value: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto SearchParamTypeCode: description: See http://hl7.org/fhir/ValueSet/search-param-type type: object title: Data types allowed to be used for search parameters. properties: extension: type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/SearchParamTypeCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto CodeableConcept: description: 'Auto-generated from StructureDefinition for CodeableConcept, last updated 2017-04-19T07:44:43.294+10:00. Concept - reference to a terminology or just text. See http://hl7.org/fhir/StructureDefinition/CodeableConcept' type: object properties: coding: description: Code defined by a terminology system type: array items: $ref: '#/components/schemas/Coding' x-go-name: Coding extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' text: $ref: '#/components/schemas/String' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto ResourceTypeCode: description: See http://hl7.org/fhir/ValueSet/resource-types type: object title: One of the resource types defined as part of FHIR. properties: extension: type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/ResourceTypeCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto UnknownContentCodeCode: description: 'A code that indicates whether an application accepts unknown elements or extensions when reading resources. See http://hl7.org/fhir/ValueSet/unknown-content-code' type: object properties: extension: type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/UnknownContentCodeCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto isReference_Reference: type: object x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto ContactDetail: description: 'Auto-generated from StructureDefinition for ContactDetail, last updated 2017-04-19T07:44:43.294+10:00. Contact information. See http://hl7.org/fhir/StructureDefinition/ContactDetail' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' name: $ref: '#/components/schemas/String' telecom: description: Contact details for individual or organization type: array items: $ref: '#/components/schemas/ContactPoint' x-go-name: Telecom x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/metadatatypes_go_proto isUsageContext_Value_Value: type: object x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/metadatatypes_go_proto CapabilityStatement_Rest_Resource_ResourceInteraction: type: object title: What operations are supported? properties: code: $ref: '#/components/schemas/TypeRestfulInteractionCode' documentation: $ref: '#/components/schemas/String' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto TypeRestfulInteractionCode: description: See http://hl7.org/fhir/ValueSet/type-restful-interaction type: object title: Operations supported by REST at the type or instance level. properties: extension: type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/TypeRestfulInteractionCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto Uri: description: 'Auto-generated from StructureDefinition for uri, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type uri. See http://hl7.org/fhir/StructureDefinition/uri' type: object properties: extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: description: Primitive value for uri type: string x-go-name: Value x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto CapabilityStatement_Messaging_Endpoint: description: Where messages should be sent type: object properties: address: $ref: '#/components/schemas/Uri' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension protocol: $ref: '#/components/schemas/Coding' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto CapabilityStatement_Messaging_Event: description: Declare support for this event type: object properties: category: $ref: '#/components/schemas/MessageSignificanceCategoryCode' code: $ref: '#/components/schemas/Coding' documentation: $ref: '#/components/schemas/String' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension focus: $ref: '#/components/schemas/ResourceTypeCode' id: $ref: '#/components/schemas/String' mode: $ref: '#/components/schemas/EventCapabilityModeCode' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension request: $ref: '#/components/schemas/Reference' response: $ref: '#/components/schemas/Reference' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto RestfulCapabilityModeCode: description: See http://hl7.org/fhir/ValueSet/restful-capability-mode type: object title: The mode of a RESTful capability statement. properties: extension: type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' value: $ref: '#/components/schemas/RestfulCapabilityModeCode_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/codes_go_proto UsageContext_Value: description: Value that defines the context type: object properties: Value: $ref: '#/components/schemas/isUsageContext_Value_Value' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/metadatatypes_go_proto CapabilityStatement_Document: description: Document definition type: object properties: documentation: $ref: '#/components/schemas/String' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' mode: $ref: '#/components/schemas/DocumentModeCode' modifier_extension: description: Extensions that cannot be ignored type: array items: $ref: '#/components/schemas/Extension' x-go-name: ModifierExtension profile: $ref: '#/components/schemas/Reference' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/resources_go_proto Instant_Precision: type: integer format: int32 x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto Xhtml: description: 'Auto-generated from StructureDefinition for xhtml, last updated 2017-04-19T07:44:43.294+10:00. Primitive Type xhtml. See http://hl7.org/fhir/StructureDefinition/xhtml' type: object properties: id: $ref: '#/components/schemas/String' value: description: Actual xhtml type: string x-go-name: Value x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto Coding: description: 'Auto-generated from StructureDefinition for Coding, last updated 2017-04-19T07:44:43.294+10:00. A reference to a code defined by a terminology system. See http://hl7.org/fhir/StructureDefinition/Coding' type: object properties: code: $ref: '#/components/schemas/Code' display: $ref: '#/components/schemas/String' extension: description: Additional Content defined by implementations type: array items: $ref: '#/components/schemas/Extension' x-go-name: Extension id: $ref: '#/components/schemas/String' system: $ref: '#/components/schemas/Uri' user_selected: type: boolean version: $ref: '#/components/schemas/String' x-go-package: github.com/google/fhir/go/proto/google/fhir/proto/stu3/datatypes_go_proto securitySchemes: basic_auth: type: http scheme: basic bearer_token: type: apiKey description: The Group and Patient endpoints require a Bearer Token. 1) Put your credentials in Basic Authentication, 2) Request a bearer token from /auth/token, 3) Put "Bearer {TOKEN}" in this field (no quotes) using the bearer token retrieved in step 2 name: Authorization in: header x-original-swagger-version: '2.0'