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 Responder - Option B (Metadata)
REST Capabilities Server
| Mode | Server |
|---|---|
| Documentation | This server supports CA:FeX-2B (Search DocumentReference) and CA:FeX-3B (Retrieve Document). It enables clients to search for document metadata using chained parameters and retrieve document content using Binary or Bundle read. Bundle search is only mandated for systems implementing Transaction CA:FeX 2A; other systems MAY omit it |
Security
| Description |
|
|---|
Resource Interactions
| Resource Type | Supported Profiles | SearchType | Read | Vread | HistoryInstance | HistoryType |
|---|---|---|---|---|---|---|
| DocumentReference | SHALL | SHALL | MAY | MAY | MAY | |
| Binary | MAY | SHALL | MAY | MAY | MAY | |
| Bundle | MAY | SHALL | MAY | MAY | MAY |
Operations per resource type
DocumentReference
| Operation | Reference | Level |
|---|---|---|
| $docref | ?? | SHALL |
Binary
No operations are stated for this resource type
Bundle
No operations are stated for this resource type
Search Parameters per resource type
DocumentReference
| Name | Type | Level |
|---|---|---|
| patient | reference | SHALL |
| type | token | MAY |
| category | token | MAY |
| status | token | SHOULD |
| period | date | SHOULD |
Supported Reverse Includes:
- Provenance:target
Binary
No search parameters are stated for this resource type
Bundle
No search parameters are stated for this resource type
| CapabilityStatement |
| id : CaFeX-DataResponder-Option-B |
| url : http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataResponder-Option-B |
| title : CA:FeX CapabilityStatement - Data Responder - Option B (Metadata) |
| description : CA:FeX-2B and CA:FeX-3B – Conformance expectations for a CA:FeX Data Responder implementing Metadata Option (B). The system must support document discovery and retrieval using the /DocumentReference and /Binary endpoints. |
| status : draft |
| version : 2.2.0 |
| name : CAFEX_DataResponder_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 : server |
| documentation : This server supports CA:FeX-2B (Search DocumentReference) and CA:FeX-3B (Retrieve Document). It enables clients to search for document metadata using chained parameters and retrieve document content using Binary or Bundle read. Bundle search is only mandated for systems implementing Transaction CA:FeX 2A; other systems MAY omit it |
| 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 |
| referencePolicy : resolves |
| searchRevInclude : Provenance:target |
| interaction |
| code : search-type |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| interaction |
| code : read |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| interaction |
| code : vread |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| interaction |
| code : history-instance |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| interaction |
| code : history-type |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : patient |
| type : reference |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| searchParam |
| name : type |
| type : token |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : category |
| type : token |
| definition : http://hl7.org/fhir/SearchParameter/DocumentReference-category |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : status |
| type : token |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| searchParam |
| name : period |
| type : date |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : type |
| extension |
| url : required |
| value : status |
| operation |
| name : $docref |
| definition : http://hl7.org/fhir/OperationDefinition/DocumentReference-docref |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| resource |
| type : Binary |
| interaction |
| code : read |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| interaction |
| code : search-type |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| interaction |
| code : vread |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| interaction |
| code : history-instance |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| interaction |
| code : history-type |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| referencePolicy : resolves |
| resource |
| type : Bundle |
| interaction |
| code : read |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| interaction |
| code : search-type |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| interaction |
| code : vread |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| interaction |
| code : history-instance |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| interaction |
| code : history-type |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| referencePolicy : resolves |
<url value="http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataResponder-Option-B" />
</telecom>
</telecom>
</contact>
<description value="CA:FeX-2B and CA:FeX-3B – Conformance expectations for a CA:FeX Data Responder implementing Metadata Option (B). The system must support document discovery and retrieval using the /DocumentReference and /Binary endpoints." />
</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-2B (Search DocumentReference) and CA:FeX-3B (Retrieve Document). It enables clients to search for document metadata using chained parameters and retrieve document content using Binary or Bundle read. Bundle search is only mandated for systems implementing Transaction CA:FeX 2A; other systems MAY omit it" />
<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 url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
</extension>
</extension>
</extension>
</extension>
</extension>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</searchParam>
</extension>
</searchParam>
</extension>
</searchParam>
</extension>
</searchParam>
</extension>
</searchParam>
</extension>
</operation>
</resource>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</resource>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</extension>
</interaction>
</resource>
</rest>
</CapabilityStatement>
{
"url": "http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataResponder-Option-B",
"description": "CA:FeX-2B and CA:FeX-3B – Conformance expectations for a CA:FeX Data Responder implementing Metadata Option (B). The system must support document discovery and retrieval using the /DocumentReference and /Binary endpoints.",
"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-2B (Search DocumentReference) and CA:FeX-3B (Retrieve Document). It enables clients to search for document metadata using chained parameters and retrieve document content using Binary or Bundle read. Bundle search is only mandated for systems implementing Transaction CA:FeX 2A; other systems MAY omit it",
"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\""
},
{
"resolves"
],
"Provenance:target"
],
{
{
}
]
},
{
{
}
]
},
{
{
}
]
},
{
{
}
]
},
{
{
}
]
}
],
{
{
}
]
},
{
{
}
]
},
{
{
}
]
},
{
{
}
]
},
{
{
}
]
}
],
{
{
},
{
},
{
},
{
}
]
}
],
{
{
}
]
}
]
},
{
{
{
}
]
},
{
{
}
]
},
{
{
}
]
},
{
{
}
]
},
{
{
}
]
}
],
"resolves"
]
},
{
{
{
}
]
},
{
{
}
]
},
{
{
}
]
},
{
{
}
]
},
{
{
}
]
}
],
"resolves"
]
}
]
}
]
}