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 Consumer - Option B (Metadata Option)
REST Capabilities Client
| Mode | Client |
|---|---|
| Documentation | This client supports CA:FeX-2B and CA:FeX-3B. The client initiates a $docref operation against a DocumentReference endpoint and retrieves documents using the attachment.url found in the response. The client SHALL support reading both Bundle and Binary resources. |
Security
| Description |
|
|---|
Resource Interactions
| Resource Type | Supported Profiles | Read | SearchType | Vread | HistoryInstance | HistoryType |
|---|---|---|---|---|---|---|
| DocumentReference | ✓ | SHALL | MAY | MAY | MAY | |
| Bundle | SHALL | SHALL | MAY | MAY | MAY | |
| Binary | SHALL | MAY | MAY | MAY | MAY |
Global Operations
| Operation | Reference | Level |
|---|---|---|
| $docref | ?? | SHALL |
Search Parameters per resource type
DocumentReference
| Name | Type | Level |
|---|---|---|
| patient | reference | SHALL |
| type | token | SHALL |
| date | date | MAY |
| author | reference | MAY |
Bundle
No search parameters are stated for this resource type
Binary
No search parameters are stated for this resource type
| CapabilityStatement |
| id : CaFeX-DataConsumer-Option-B |
| url : http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataConsumer-Option-B |
| version : 2.2.0 |
| name : CAFEX_DataConsumer_Option_B |
| title : CA:FeX CapabilityStatement - Data Consumer - Option B (Metadata Option) |
| status : draft |
| experimental : False |
| date : 2025-04-02 |
| 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-2B and CA:FeX-3B – Conformance expectations for a CA:FeX Data Consumer implementing the Metadata Option (B). This system must support the use of the $docref operation to retrieve DocumentReference metadata, and subsequent retrieval of referenced documents via the attachment.url. Only /Bundle and /Binary endpoints are expected in CA:FeX for document retrieval. |
| 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-2B and CA:FeX-3B. The client initiates a $docref operation against a DocumentReference endpoint and retrieves documents using the attachment.url found in the response. The client SHALL support reading both Bundle and Binary 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 |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| type : DocumentReference |
| interaction |
| code : read |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| code : search-type |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| code : vread |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| code : history-instance |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| code : history-type |
| searchParam |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| name : patient |
| definition : http://hl7.org/fhir/SearchParameter/clinical-patient |
| type : reference |
| searchParam |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| name : type |
| definition : http://hl7.org/fhir/SearchParameter/clinical-type |
| type : token |
| searchParam |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| name : date |
| definition : http://hl7.org/fhir/SearchParameter/clinical-date |
| type : date |
| searchParam |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| name : author |
| definition : http://hl7.org/fhir/SearchParameter/DocumentReference-author |
| type : reference |
| resource |
| type : Bundle |
| documentation : This client retrieves Bundle resources as referenced from DocumentReference.attachment.url. These are used when the document is submitted as a FHIR document. |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| code : read |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| code : search-type |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| code : vread |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| code : history-instance |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| code : history-type |
| resource |
| type : Binary |
| documentation : This client retrieves Binary resources as referenced from DocumentReference.attachment.url. These are typically used to return non-structured documents (PDF, CDA). |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| code : read |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| code : search-type |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| code : vread |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| code : history-instance |
| interaction |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| code : history-type |
| operation |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| name : $docref |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/OperationDefinition/docref |
<url value="http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataConsumer-Option-B" />
</telecom>
</telecom>
</contact>
<description value="CA:FeX-2B and CA:FeX-3B – Conformance expectations for a CA:FeX Data Consumer implementing the Metadata Option (B).\nThis system must support the use of the $docref operation to retrieve DocumentReference metadata,\nand subsequent retrieval of referenced documents via the attachment.url.\nOnly /Bundle and /Binary endpoints are expected in CA:FeX for document retrieval." />
</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-2B and CA:FeX-3B. The client initiates a $docref operation against a DocumentReference endpoint\nand retrieves documents using the attachment.url found in the response.\nThe client SHALL support reading both Bundle and Binary 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>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</searchParam>
</extension>
</searchParam>
</extension>
</searchParam>
</extension>
</searchParam>
</resource>
<documentation value="This client retrieves Bundle resources as referenced from DocumentReference.attachment.url. These are used when the document is submitted as a FHIR document." />
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</resource>
<documentation value="This client retrieves Binary resources as referenced from DocumentReference.attachment.url. These are typically used to return non-structured documents (PDF, CDA)." />
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</resource>
</extension>
</operation>
</rest>
</CapabilityStatement>
{
{
{
},
{
}
]
}
],
"description": "CA:FeX-2B and CA:FeX-3B – Conformance expectations for a CA:FeX Data Consumer implementing the Metadata Option (B).\nThis system must support the use of the $docref operation to retrieve DocumentReference metadata,\nand subsequent retrieval of referenced documents via the attachment.url.\nOnly /Bundle and /Binary endpoints are expected in CA:FeX for document retrieval.",
],
"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-2B and CA:FeX-3B. The client initiates a $docref operation against a DocumentReference endpoint\nand retrieves documents using the attachment.url found in the response.\nThe client SHALL support reading both Bundle and Binary 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": "This client retrieves Bundle resources as referenced from DocumentReference.attachment.url. These are used when the document is submitted as a FHIR document.",
{
{
}
],
},
{
{
}
],
},
{
{
}
],
},
{
{
}
],
},
{
{
}
],
}
]
},
{
"documentation": "This client retrieves Binary resources as referenced from DocumentReference.attachment.url. These are typically used to return non-structured documents (PDF, CDA).",
{
{
}
],
},
{
{
}
],
},
{
{
}
],
},
{
{
}
],
},
{
{
}
],
}
]
}
],
{
{
}
],
}
]
}
]
}