MyHealthWay
1.0.0 - Trial-Implementation
KR
MyHealthWay - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://hins.or.kr/fhir/MyHealthWay/CapabilityStatement/myhealthway-capabilitystatement-server | Version: 1.0.0 | |||
Active as of 2023-11-14 | Computable Name: MyHealthWayServerCapabilityStatement |
MyHealthWay Client가 요청한 쿼리에 대한 응답을 제공할 책임이 있는 MyHealthWay Server의 예상 기능을 설명. MyHealthWay Server에서 지원하는 FHIR Profiles, RESTful Operations, Search Parameters의 전체 목록을 정의함. MyHealthWay Client는 이 목록에서 사용 사례 및 기타 상황별 요구 사항에 따라 필요한 데이터에 접근할 수 있음.
Raw OpenAPI-Swagger Definition file | Download
application/fhir+xml
, SHALL support application/fhir+json
application/fhir+json
Note 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.
server
MyHealthWay Server는 다음 사항을 반드시(SHALL) 준수:
FHIR specification을 따라 RESTful operation을 구현.
다음 응답을 반환.
(Status 400): invalid parameter (=잘못된 매개변수)
(Status 401/4xx): unauthorized request (=승인되지 않은 요청)
(Status 403): insufficient scopes (=권한 범위 부족)
(Status 404): unknown resource (=알 수 없는 리소스)
모든 MyHealthWay 상호 작용에 대해 JSON 형식을 지원.
MyHealthWay Server는 다음 사항을 가능한 한(SHOULD) 준수:
모든 MyHealthWay 상호작용에 대해 XML 형식을 지원.
각 인스턴스의 FHIR 'meta.profile' 속성의 일부로 지원되는 MyHealthWay Profile을 식별.
- MyHealthWay Server는 승인되지 않은 요청에 대해 다음 중 하나를 반환하여 거부할 것을 반드시(SHALL) 준수: 'HTTP 401' "Unauthorized", 'HTTP 403' "Forbidden", 'HTTP 404' "Not Found"
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | V-R | S | U | P | C | D | H-I | H-T | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Patient | Supported profiles: MyHealthWay Patient Profile | y | y | y | y | y | y | y | y | y | _id, address, birthdate, gender, identifier, name, organization | |||
Organization | Supported profiles: MyHealthWay Organization Profile | y | y | y | y | y | y | y | y | y | telecom, address, identifier, name, type | |||
Practitioner | Supported profiles: MyHealthWay Practitioner Profile | y | y | y | y | y | y | y | y | y | code, _id, name | |||
PractitionerRole | Supported profiles: MyHealthWay PractitionerRole Profile | y | y | y | y | y | y | y | y | y | organization, practitioner, specialty, role | |||
Encounter | Supported profiles: MyHealthWay Encounter Profile | y | y | y | y | y | y | y | y | y | participant, patient, service-provider, identifier | |||
AllergyIntolerance | Supported profiles: MyHealthWay AllergyIntolerance Profile | y | y | y | y | y | y | y | y | y | code, patient, identifier | |||
Condition | Supported profiles: MyHealthWay Condition Profile | y | y | y | y | y | y | y | y | y | code, patient, identifier | |||
MedicationRequest | Supported profiles: MyHealthWay MedicationRequest Profile | y | y | y | y | y | y | y | y | y | intent, patient, identifier, code | |||
Procedure | Supported profiles: MyHealthWay Procedure Profile | y | y | y | y | y | y | y | y | y | code, date, patient, identifier | |||
ImagingStudy | Supported profiles: MyHealthWay ImagingStudy Profile | y | y | y | y | y | y | y | y | y | modality, patient, series, identifier, encounter, endpoint | |||
Observation | Supported profiles: MyHealthWay Observation Profile for Exam MyHealthWay Observation Profile for Laboratory Result | y | y | y | y | y | y | y | y | y | category, code, date, patient, performer, encounter, identifier | |||
DiagnosticReport | Supported profiles: MyHealthWay DiagnosticReport Profile for Diagnostic Imaging MyHealthWay DiagnosticReport Profile for Pathology Result | y | y | y | y | y | y | y | y | y | identifier, category, code, patient, encounter, date, result, media | |||
Endpoint | Supported profiles: MyHealthWay Endpoint Profile | y | y | y | y | y | y | y | y | y | identifier, connection-type, name, organization | |||
Media | Supported profiles: MyHealthWay Media Profile | y | y | y | y | y | y | y | y | y | identifier, patient, encounter, site | |||
DocumentReference | Supported profiles: MyHealthWay DocumentReference Profile | y | y | y | y | y | y | y | y | y | identifier, type, patient, encounter, date |
resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | _id | token | |
SHALL | identifier | token | 클라이언트는 적어도 |
SHALL | name | string | |
SHOULD | birthdate | date | 클라이언트는 반드시(SHALL) day 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) day 수준의 정확도를 가지는 값을 지원해야 한다. |
SHOULD | gender | token | 클라이언트는 적어도 |
SHOULD | organization | reference | |
MAY | address | string |
resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | 클라이언트는 적어도 |
SHOULD | name | string | |
MAY | telecom | token | 클라이언트는 적어도 |
MAY | address | string | |
MAY | type | token |
resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | practitioner | reference | 클라이언트는 적어도 |
SHOULD | specialty | token | 클라이언트는 적어도 |
SHOULD | role | token | 클라이언트는 적어도 |
MAY | organization | reference | 클라이언트는 적어도 |
resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | 클라이언트는 적어도 |
SHALL | identifier | token | 클라이언트는 적어도 |
MAY | participant | reference | 클라이언트는 적어도 |
MAY | service-provider | reference | 클라이언트는 적어도 |
resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | 클라이언트는 적어도 |
SHALL | identifier | token | 클라이언트는 적어도 |
SHOULD | code | token | 클라이언트는 적어도 |
resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | code | token | 클라이언트는 적어도 |
SHALL | patient | reference | 클라이언트는 적어도 |
SHALL | identifier | token | 클라이언트는 적어도 |
resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | 클라이언트는 적어도 |
SHALL | identifier | token | 클라이언트는 적어도 |
SHOULD | intent | token | 클라이언트는 적어도 |
SHOULD | code | token | 클라이언트는 적어도 |
resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | 클라이언트는 적어도 |
SHALL | identifier | token | 클라이언트는 적어도 |
SHOULD | code | token | 클라이언트는 적어도 |
SHOULD | date | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | patient | reference | 클라이언트는 적어도 |
SHALL | identifier | token | 클라이언트는 적어도 |
SHALL | encounter | reference | 클라이언트는 적어도 |
SHALL | endpoint | reference | 클라이언트는 적어도 |
MAY | modality | token | 클라이언트는 적어도 |
MAY | series | token | 클라이언트는 적어도 |
resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | category | token | 클라이언트는 적어도 |
SHALL | patient | reference | 클라이언트는 적어도 |
SHALL | identifier | token | 클라이언트는 적어도 |
SHOULD | performer | reference | 클라이언트는 적어도 |
SHOULD | encounter | reference | 클라이언트는 적어도 |
MAY | code | token | 클라이언트는 적어도 |
MAY | date | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | 클라이언트는 적어도 |
SHALL | code | token | 클라이언트는 적어도 |
SHALL | patient | reference | 클라이언트는 적어도 |
SHALL | encounter | reference | 클라이언트는 적어도 |
SHOULD | category | token | 클라이언트는 적어도 |
SHOULD | result | reference | 클라이언트는 적어도 |
SHOULD | media | reference | 클라이언트는 적어도 |
MAY | date | date | 클라이언트는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) second + time offset 수준의 정확도를 가지는 값을 지원해야 한다. |
resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHALL | identifier | token | 클라이언트는 적어도 |
SHALL | connection-type | token | 클라이언트는 적어도 |
SHALL | name | string | |
SHOULD | organization | reference | 클라이언트는 적어도 |
resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHOULD | identifier | token | 클라이언트는 적어도 |
SHOULD | patient | reference | 클라이언트는 적어도 |
SHOULD | encounter | reference | 클라이언트는 적어도 |
SHOULD | site | token | 클라이언트는 적어도 |
resolves
search-type
, read
.vread
, history-instance
.create
, update
, patch
, delete
, history-type
.Conformance | Parameter | Type | Documentation |
---|---|---|---|
SHOULD | identifier | token | 클라이언트는 적어도 |
SHOULD | type | token | 클라이언트는 적어도 |
SHOULD | patient | reference | 클라이언트는 적어도 |
SHOULD | encounter | reference | 클라이언트는 적어도 |
SHOULD | date | date | 클라이언트는 반드시(SHALL) day 수준의 정확도를 가지는 값을 제공해야 한다. 서버는 반드시(SHALL) day 수준의 정확도를 가지는 값을 지원해야 한다. |