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 B (Metadata)
REST Capabilities Client
| Mode | Client |
|---|---|
| Documentation | This client supports CA:FeX-1B – submission of DocumentReference resources (for searchable metadata) and associated content (such as Binary or Bundle resources) to a Data Recipient to enable metadata-based document discovery. |
Security
| Description |
|
|---|
Resource Interactions
| Resource Type | Supported Profiles | Create | Update | Patch | Delete |
|---|---|---|---|---|---|
| DocumentReference | SHOULD | MAY | MAY | MAY |
Operations per resource type
DocumentReference
| Operation | Reference | Level |
|---|---|---|
| $generate-metadata | ?? | SHALL |
| CapabilityStatement |
| id : CaFeX-DataSource-Option-B |
| url : http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataSource-Option-B |
| title : CA:FeX CapabilityStatement - Data Source - Option B (Metadata) |
| description : CA:FeX-1B – Conformance expectations for a CA:FeX Data Source implementing Metadata Option (B). The system must support submission and management of DocumentReference and Binary resources for metadata-based discovery. |
| status : draft |
| version : 2.2.0 |
| name : CAFEX_DataSource_Option_B |
| 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 : client |
| documentation : This client supports CA:FeX-1B – submission of DocumentReference resources (for searchable metadata) and associated content (such as Binary or Bundle resources) to a Data Recipient to enable metadata-based document discovery. |
| 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 : DocumentReference |
| operation |
| name : $generate-metadata |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/OperationDefinition/generate-metadata |
| 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 |
<url value="http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataSource-Option-B" />
</telecom>
</telecom>
</contact>
<description value="CA:FeX-1B – Conformance expectations for a CA:FeX Data Source implementing Metadata Option (B). The system must support submission and management of DocumentReference and Binary resources for metadata-based discovery." />
</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-1B – submission of DocumentReference resources (for searchable metadata) and associated content (such as Binary or Bundle resources) to a Data Recipient to enable metadata-based document discovery." />
<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>
<definition value="http://fhir.infoway-inforoute.ca/io/cafex/OperationDefinition/generate-metadata" />
</operation>
</resource>
</rest>
</CapabilityStatement>
{
"description": "CA:FeX-1B – Conformance expectations for a CA:FeX Data Source implementing Metadata Option (B). The system must support submission and management of DocumentReference and Binary resources for metadata-based discovery.",
"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 client supports CA:FeX-1B – submission of DocumentReference resources (for searchable metadata) and associated content (such as Binary or Bundle resources) to a Data Recipient to enable metadata-based document discovery.",
"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\""
},
{
{
{
}
]
}
],
{
{
}
]
},
{
{
}
]
},
{
{
}
]
},
{
{
}
]
}
]
}
]
}
]
}