DFT Ballot - This specification is currently in ballot review and subject to change. It is not ready for limited roll-out or production level use. For a full list of available versions, see the Directory of published versions
CA:FeX CapabilityStatement - Data Source - Option A (Submit FHIR Document)
REST Capabilities Client
| Mode | Client |
|---|---|
| Documentation | This client supports CA:FeX-1A: Submit FHIR Document. It performs an HTTP POST to the /Bundle endpoint of a CA:FeX-compliant Data Recipient. The submitted Bundle MUST be a valid FHIR Document (type 'document') and include a Composition as the first entry. |
Security
| Description |
|
|---|
Resource Interactions
| Resource Type | Supported Profiles | Create | Update | Patch | Delete |
|---|---|---|---|---|---|
| Bundle | SHALL | MAY | MAY | MAY | |
| Composition | |||||
| Binary |
| CapabilityStatement |
| id : CaFeX-DataSource-Option-A |
| url : http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataSource-Option-A |
| version : 2.2.0 |
| name : CAFEX_DataSource_Option_A |
| title : CA:FeX CapabilityStatement - Data Source - Option A (Submit FHIR Document) |
| status : draft |
| experimental : False |
| date : 2025-04-01 |
| publisher : Canada Health Infoway |
| contact |
| name : National Standards Release Centre |
| telecom |
| system : url |
| value : http://www.infoway-inforoute.ca |
| telecom |
| system : email |
| value : standards@infoway-inforoute.ca |
| description : CA:FeX-1A: Submit FHIR Document – Conformance expectations for a CA:FeX Data Source implementing the Bundle Option (A). In this transaction, a Data Source submits a FHIR Document Bundle (type 'document' with a Composition as the first entry) via an HTTP POST to the /Bundle endpoint. Optionality: R. Conditional create is not supported. |
| jurisdiction |
| coding |
| system : urn:iso:std:iso:3166 |
| code : CA |
| copyright : Copyright © 2021–2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy). |
| kind : requirements |
| fhirVersion : 4.0.1 |
| format : json |
| format : xml |
| rest |
| mode : client |
| documentation : This client supports CA:FeX-1A: Submit FHIR Document. It performs an HTTP POST to the /Bundle endpoint of a CA:FeX-compliant Data Recipient. The submitted Bundle MUST be a valid FHIR Document (type 'document') and include a Composition as the first entry. |
| security |
| description : 1. See the security section of the CA:FeX guide for security requirements and recommendations. 2. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` "Unauthorized", `HTTP 403` "Forbidden", or `HTTP 404` "Not Found" |
| resource |
| type : Bundle |
| documentation : The client issues an HTTP POST to [base]/Bundle to submit a FHIR Document Bundle. The server is responsible for assigning the id and metadata. |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| code : create |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| code : update |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| code : patch |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| code : delete |
| resource |
| type : Composition |
| documentation : A Composition resource is included as the first entry in the submitted Bundle to represent the document header. It is not submitted or managed independently. |
| resource |
| type : Binary |
| documentation : Binary resources may be included within the Bundle to carry attachments (e.g., PDFs, images), but are not submitted or modified independently. |
<url value="http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataSource-Option-A" />
</telecom>
</telecom>
</contact>
<description value="CA:FeX-1A: Submit FHIR Document – Conformance expectations for a CA:FeX Data Source implementing the Bundle Option (A). In this transaction, a Data Source submits a FHIR Document Bundle (type 'document' with a Composition as the first entry) via an HTTP POST to the /Bundle endpoint. Optionality: R. Conditional create is not supported." />
</jurisdiction>
<copyright value="Copyright © 2021–2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy)." />
<documentation value="This client supports CA:FeX-1A: Submit FHIR Document. It performs an HTTP POST to the /Bundle endpoint of a CA:FeX-compliant Data Recipient.\nThe submitted Bundle MUST be a valid FHIR Document (type 'document') and include a Composition as the first entry." />
<description value="1. See the security section of the CA:FeX guide for security requirements and recommendations.\n2. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` "Unauthorized", `HTTP 403` "Forbidden", or `HTTP 404` "Not Found"" />
</security>
<documentation value="The client issues an HTTP POST to [base]/Bundle to submit a FHIR Document Bundle.\nThe server is responsible for assigning the id and metadata." />
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</resource>
<documentation value="A Composition resource is included as the first entry in the submitted Bundle to represent the document header.\nIt is not submitted or managed independently." />
</resource>
<documentation value="Binary resources may be included within the Bundle to carry attachments (e.g., PDFs, images), \nbut are not submitted or modified independently." />
</resource>
</rest>
</CapabilityStatement>
{
{
{
},
{
}
]
}
],
"description": "CA:FeX-1A: Submit FHIR Document – Conformance expectations for a CA:FeX Data Source implementing the Bundle Option (A). In this transaction, a Data Source submits a FHIR Document Bundle (type 'document' with a Composition as the first entry) via an HTTP POST to the /Bundle endpoint. Optionality: R. Conditional create is not supported.",
],
"copyright": "Copyright © 2021–2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
"json",
"xml"
],
{
"documentation": "This client supports CA:FeX-1A: Submit FHIR Document. It performs an HTTP POST to the /Bundle endpoint of a CA:FeX-compliant Data Recipient.\nThe submitted Bundle MUST be a valid FHIR Document (type 'document') and include a Composition as the first entry.",
"description": "1. See the security section of the CA:FeX guide for security requirements and recommendations.\n2. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` \"Unauthorized\", `HTTP 403` \"Forbidden\", or `HTTP 404` \"Not Found\""
},
{
"documentation": "The client issues an HTTP POST to [base]/Bundle to submit a FHIR Document Bundle.\nThe server is responsible for assigning the id and metadata.",
{
{
}
],
},
{
{
}
],
},
{
{
}
],
},
{
{
}
],
}
]
},
{
"documentation": "A Composition resource is included as the first entry in the submitted Bundle to represent the document header.\nIt is not submitted or managed independently."
},
{
"documentation": "Binary resources may be included within the Bundle to carry attachments (e.g., PDFs, images), \nbut are not submitted or modified independently."
}
]
}
]
}