| Package | ihe.iti.npfs |
| Resource Type | CapabilityStatement |
| Id | IHE.NPFS.FileConsumerOption |
| FHIR Version | R4 |
| Source | https://profiles.ihe.net/ITI/NPFS/https://build.fhir.org/ig/IHE/ITI.NPFS/CapabilityStatement-IHE.NPFS.FileConsumerOption.html |
| URL | https://profiles.ihe.net/ITI/NPFS/CapabilityStatement/IHE.NPFS.FileConsumerOption |
| Version | 2.2.1-current |
| Status | active |
| Date | 2022-10-27 |
| Name | IHE_NPFS_FileConsumerOption |
| Title | File Consumer (client) implementing Retrieve Document |
| Realm | uv |
| Authority | ihe |
| Description | IHE ITI Non-patient File Sharing (NPFS) - File Consumer (client) - with ITI-109 Retrieve File |
| Kind | requirements |
No resources found
| StructureDefinition | |
| IHE.NPFS.DocumentReference | NPFS DocumentReference |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement IHE.NPFS.FileConsumerOption
application/fhir+xml, application/fhir+jsonNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
clientCapabilityStatement for File Consumer implementing Retrieve Document
Recommend ATNA, encouraged IHE-IUA or SMART-app-launch
search-systeminteraction.The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| DocumentReference | https://profiles.ihe.net/ITI/NPFS/StructureDefinition/IHE.NPFS.DocumentReference | y | y | _id, identifier, patient, date, author.identifier, format, language, location, status, relatesto, relation, relationship | |||||
| Binary | y |
read, search-type.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Logical id of this artifact |
| SHALL | identifier | token | Logical identifier of this artifact |
| SHALL | patient | token | This parameter shall always be used in this transaction to find resources that do not have the patient element valued, e.g., patient:missing=true |
| SHALL | date | date | when the file, to which the DocumentReference refers, was submitted |
| SHALL | author.identifier | token | The author that has submitted the file |
| SHALL | format | token | File's format |
| SHALL | language | token | The language of the file |
| SHALL | location | uri | Where the file can be found |
| SHALL | status | token | The status of the file |
| SHALL | relatesto | reference | One or more existing DocumentReference Resources that have been replaced by the submitted DocumentReference Resource |
| SHALL | relation | token | The type of relation that the file being searched has with the targeted file specified in the relatesTo parameter |
| SHALL | relationship | composite | The combination of the relatesTo and relation search parameter. |
{
"resourceType": "CapabilityStatement",
"id": "IHE.NPFS.FileConsumerOption",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "https://profiles.ihe.net/ITI/NPFS/CapabilityStatement/IHE.NPFS.FileConsumerOption",
"version": "2.2.1-current",
"name": "IHE_NPFS_FileConsumerOption",
"title": "File Consumer (client) implementing Retrieve Document",
"status": "active",
"experimental": false,
"date": "2022-10-27",
"publisher": "IHE IT Infrastructure Technical Committee",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "https://www.ihe.net/ihe_domains/it_infrastructure/"
}
]
},
{
"telecom": [
{
"system": "email",
"value": "iti@ihe.net"
}
]
},
{
"name": "IHE IT Infrastructure Technical Committee",
"telecom": [
{
"system": "email",
"value": "iti@ihe.net"
}
]
}
],
"description": "IHE ITI Non-patient File Sharing (NPFS) - File Consumer (client) - with ITI-109 Retrieve File",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001"
}
]
}
],
"kind": "requirements",
"fhirVersion": "4.0.1",
"format": [
"application/fhir+xml",
"application/fhir+json"
],
"rest": [
{
"mode": "client",
"documentation": "CapabilityStatement for File Consumer implementing Retrieve Document",
"security": {
"description": "Recommend [ATNA](https://profiles.ihe.net/ITI/TF/Volume1/ch-9.html), encouraged [IHE-IUA](https://profiles.ihe.net/ITI/IUA/index.html) or [SMART-app-launch](http://www.hl7.org/fhir/smart-app-launch/)"
},
"resource": [
{
"type": "DocumentReference",
"profile": "https://profiles.ihe.net/ITI/NPFS/StructureDefinition/IHE.NPFS.DocumentReference",
"interaction": [
{
"code": "read"
},
{
"code": "search-type"
}
],
"searchParam": [
{
"name": "_id",
"type": "token",
"documentation": "Logical id of this artifact"
},
{
"name": "identifier",
"type": "token",
"documentation": "Logical identifier of this artifact"
},
{
"name": "patient",
"type": "token",
"documentation": "This parameter shall always be used in this transaction to find resources that do not have the patient element valued, e.g., patient:missing=true"
},
{
"name": "date",
"type": "date",
"documentation": "when the file, to which the DocumentReference refers, was submitted"
},
{
"name": "author.identifier",
"type": "token",
"documentation": "The author that has submitted the file"
},
{
"name": "format",
"type": "token",
"documentation": "File's format"
},
{
"name": "language",
"type": "token",
"documentation": "The language of the file"
},
{
"name": "location",
"type": "uri",
"documentation": "Where the file can be found"
},
{
"name": "status",
"type": "token",
"documentation": "The status of the file"
},
{
"name": "relatesto",
"type": "reference",
"documentation": "One or more existing DocumentReference Resources that have been replaced by the submitted DocumentReference Resource"
},
{
"name": "relation",
"type": "token",
"documentation": "The type of relation that the file being searched has with the targeted file specified in the relatesTo parameter"
},
{
"name": "relationship",
"type": "composite",
"documentation": "The combination of the relatesTo and relation search parameter."
}
]
},
{
"type": "Binary",
"interaction": [
{
"code": "read"
}
]
}
],
"interaction": [
{
"code": "search-system"
}
]
}
]
}