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 Recipient - Option A (Accept FHIR Document)
REST Capabilities Server
| Mode | Server |
|---|---|
| Documentation | This server supports CA:FeX-1A: Submit FHIR Document. Data Recipients SHALL support receiving a FHIR Document Bundle via an HTTP POST to the /Bundle endpoint. The submitted Bundle MUST be a valid FHIR Document with type 'document', containing a Composition as the first entry and other referenced resources. |
Security
| Description |
|
|---|
Resource Interactions
| Resource Type | Supported Profiles | Create | Update | Patch | Delete |
|---|---|---|---|---|---|
| Bundle | SHALL | MAY | MAY | MAY |
| CapabilityStatement |
| id : CaFeX-DataRecipient-Option-A |
| url : http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataRecipient-Option-A |
| title : CA:FeX CapabilityStatement - Data Recipient - Option A (Accept FHIR Document) |
| description : CA:FeX-1A: Submit FHIR Document – Conformance expectations for a CA:FeX Data Recipient implementing the Bundle Option (A). The system must accept a FHIR Document Bundle via POST to the /Bundle endpoint. Optionality: R. Conditional create is not supported. |
| status : draft |
| version : 2.2.0 |
| name : CAFEX_DataRecipient_Option_A |
| date : 2025-04-01 |
| kind : requirements |
| experimental : False |
| fhirVersion : 4.0.1 |
| format : json |
| format : xml |
| jurisdiction |
| coding |
| code : CA |
| system : urn:iso:std:iso:3166 |
| 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 |
| 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). |
| rest |
| mode : server |
| documentation : This server supports CA:FeX-1A: Submit FHIR Document. Data Recipients SHALL support receiving a FHIR Document Bundle via an HTTP POST to the /Bundle endpoint. The submitted Bundle MUST be a valid FHIR Document with type 'document', containing a Composition as the first entry and other referenced resources. |
| 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 |
| interaction |
| code : create |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| interaction |
| code : create |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| interaction |
| code : update |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| interaction |
| code : patch |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| interaction |
| code : delete |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| documentation : The server SHALL support HTTP POST to [base]/Bundle for document submission. The Bundle MUST be of type 'document' with a Composition as the first entry. The server SHALL assign ID, versionId, and lastUpdated. Conditional create is not supported. On success, the server returns a 201 Created response, with Location, ETag, and Last-Modified headers. On error, return 400 (Bad Request) or 422 (Unprocessable Entity) with OperationOutcome. |
<url value="http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataRecipient-Option-A" />
</telecom>
</telecom>
</contact>
<description value="CA:FeX-1A: Submit FHIR Document – Conformance expectations for a CA:FeX Data Recipient implementing the Bundle Option (A). The system must accept a FHIR Document Bundle via 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 server supports CA:FeX-1A: Submit FHIR Document. Data Recipients SHALL support receiving a FHIR Document Bundle via an HTTP POST to the /Bundle endpoint.\nThe submitted Bundle MUST be a valid FHIR Document with type 'document', containing a Composition as the first entry and other referenced resources." />
<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 server SHALL support HTTP POST to [base]/Bundle for document submission.\nThe Bundle MUST be of type 'document' with a Composition as the first entry.\nThe server SHALL assign ID, versionId, and lastUpdated. Conditional create is not supported.\nOn success, the server returns a 201 Created response, with Location, ETag, and Last-Modified headers.\nOn error, return 400 (Bad Request) or 422 (Unprocessable Entity) with OperationOutcome." />
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</resource>
</rest>
</CapabilityStatement>
{
"url": "http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataRecipient-Option-A",
"description": "CA:FeX-1A: Submit FHIR Document – Conformance expectations for a CA:FeX Data Recipient implementing the Bundle Option (A). The system must accept a FHIR Document Bundle via POST to the /Bundle endpoint. Optionality: R. Conditional create is not supported.",
"json",
"xml"
],
],
{
{
},
{
}
]
}
],
"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).",
{
"documentation": "This server supports CA:FeX-1A: Submit FHIR Document. Data Recipients SHALL support receiving a FHIR Document Bundle via an HTTP POST to the /Bundle endpoint.\nThe submitted Bundle MUST be a valid FHIR Document with type 'document', containing a Composition as the first entry and other referenced resources.",
"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 server SHALL support HTTP POST to [base]/Bundle for document submission.\nThe Bundle MUST be of type 'document' with a Composition as the first entry.\nThe server SHALL assign ID, versionId, and lastUpdated. Conditional create is not supported.\nOn success, the server returns a 201 Created response, with Location, ETag, and Last-Modified headers.\nOn error, return 400 (Bad Request) or 422 (Unprocessable Entity) with OperationOutcome."
}
]
}
]
}