의료기관 실증
본 문서는 의료기관 실증을 목표로 정의한 Resource 들의 Structure를 KR-Core와 구조적인 마이그레이션을 구성한 Structure를 정의합니다.
목차
* 각 리소스별 항목은 HL7 FHIR R4B 기반의 Implement Guide 를 베이스로 구성하였습니다.
FHIR R4 Implement Guide
* 또한 각 리소스별 항목은 R4B 기반의 KR-CORE Implement Guide 를 준수하여 구성하였습니다.
FHIR R4 기반의 Kr-core
※ This implementation guide (IG) is provided to support the use of FHIR®️©️. This IG is based on the KR Core version 1.0.1 which, in turn, is based on FHIR core Version R4.
Device
평화이즈에서 자체적으로 정의한 Device 입니다.
세부적인 사항은 아래의 tree를 확인하여 구현해주세요.
SvcCore_Device (Device) | I | Device | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | 1..* | Identifier | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
definition | 0..1 | Reference(DeviceDefinition) | |
udiCarrier | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
deviceIdentifier | Σ | 0..1 | string |
issuer | 0..1 | uri | |
jurisdiction | 0..1 | uri | |
carrierAIDC | Σ | 0..1 | base64Binary |
carrierHRF | Σ | 0..1 | string |
entryType | 0..1 | codeBinding | |
status | Σ ?! | 0..1 | codeBinding |
statusReason | 0..* | CodeableConceptBinding | |
distinctIdentifier | 0..1 | string | |
manufacturer | 1..1 | string | |
manufactureDate | 0..1 | dateTime | |
expirationDate | 0..1 | dateTime | |
lotNumber | 0..1 | string | |
serialNumber | 0..1 | string | |
deviceName | 1..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
name | 1..1 | string | |
type | 1..1 | codeBinding | |
modelNumber | 0..1 | string | |
partNumber | 0..1 | string | |
type | 1..1 | CodeableConcept | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 1..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uriFixed Value |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
specialization | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
systemType | 1..1 | CodeableConcept | |
version | 0..1 | string | |
version | 1..1 | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
type | 1..1 | CodeableConcept | |
component | 0..1 | Identifier | |
value | 1..1 | string | |
property | 0..* | BackboneElement | |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
type | 1..1 | CodeableConcept | |
valueQuantity | 0..* | Quantity | |
valueCode | 0..* | CodeableConcept | |
patient | 1..1 | Reference(KRCore_Patient) | |
owner | 1..1 | Reference(KRCore_HealthcareOrganization) | |
contact | 0..* | ContactPoint | |
location | 0..1 | Reference(Location) | |
url | 0..1 | uri | |
note | 0..* | Annotation | |
safety | Σ | 0..* | CodeableConcept |
parent | 0..1 | Reference(Device) |
Device | |
Definition | A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device. |
Cardinality | 0...* |
Invariants |
|
Mappings |
|
Device.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Device.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
Device.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
Device.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
Device.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
Device.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
Device.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.identifier | |
Definition | Unique instance identifiers assigned to a device by manufacturers other organizations or owners. |
Cardinality | 1...* |
Type | Identifier |
Comments | The barcode string from a barcode present on a device label or package may identify the instance, include names given to the device in local usage, or may identify the type of device. If the identifier identifies the type of device, Device.type element should be used. |
Invariants |
|
Mappings |
|
Device.identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Device.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Device.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
Device.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
Device.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. 연세의료원 주관 DTx 플랫폼 사업의 경우 https://connectdtx.net/phicode 을 고정값으로 활용. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient PHI_CODE 식별체계 식별자 https://connectdtx.net/phicode |
Mappings |
|
Device.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. 연세의료원 주관 DTx 플랫폼 사업의 경우 PHI_CODE 식별체계 식별자 활용 |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
Device.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
Device.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
Device.definition | |
Definition | The reference to the definition for the device. |
Cardinality | 0...1 |
Type | Reference(DeviceDefinition) |
Invariants |
|
Device.udiCarrier | |
Definition | Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Comments | UDI may identify an unique instance of a device, or it may only identify the type of the device. See UDI mappings for a complete mapping of UDI parts to Device. |
Invariants |
|
Mappings |
|
Device.udiCarrier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Device.udiCarrier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.udiCarrier.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.udiCarrier.deviceIdentifier | |
Definition | The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | DI |
Invariants |
|
Mappings |
|
Device.udiCarrier.issuer | |
Definition | Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di. |
Cardinality | 0...1 |
Type | uri |
Alias | Barcode System |
Invariants |
|
Mappings |
|
Device.udiCarrier.jurisdiction | |
Definition | The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi. |
Cardinality | 0...1 |
Type | uri |
Requirements | Allows a recipient of a UDI to know which database will contain the UDI-associated metadata. |
Invariants |
|
Mappings |
|
Device.udiCarrier.carrierAIDC | |
Definition | The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats *SHALL* be base64 encoded. |
Cardinality | 0...1 |
Type | base64Binary |
Summary | True |
Alias | Automatic Identification and Data Capture |
Comments | The AIDC form of UDIs should be scanned or otherwise used for the identification of the device whenever possible to minimize errors in records resulting from manual transcriptions. If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label. |
Invariants |
|
Mappings |
|
Device.udiCarrier.carrierHRF | |
Definition | The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Alias | Human Readable Form |
Comments | If separate barcodes for DI and PI are present, concatenate the string with DI first and in order of human readable expression on label. |
Invariants |
|
Mappings |
|
Device.udiCarrier.entryType | |
Definition | A coded entry to indicate how the data was entered. |
Cardinality | 0...1 |
Type | code |
Binding | Codes to identify how UDI data was entered. |
Requirements | Supports a way to distinguish hand entered from machine read data. |
Invariants |
|
Mappings |
|
Device.status | |
Definition | Status of the Device availability. |
Cardinality | 0...1 |
Type | code |
Binding | The availability status of the device. |
Modifier | True |
Summary | True |
Comments | This element is labeled as a modifier because the status contains the codes inactive and entered-in-error that mark the device (record)as not currently valid. |
Invariants |
|
Mappings |
|
Device.statusReason | |
Definition | Reason for the dtatus of the Device availability. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | The availability status reason of the device. |
Invariants |
|
Mappings |
|
Device.distinctIdentifier | |
Definition | The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product. |
Cardinality | 0...1 |
Type | string |
Alias | Distinct Identification Code (DIC) |
Comments | For example, this applies to devices in the United States regulated under Code of Federal Regulation 21CFR§1271.290(c). |
Invariants |
|
Mappings |
|
Device.manufacturer | |
Definition | A name of the manufacturer. |
Cardinality | 1...1 |
Type | string |
Invariants |
|
Mappings |
|
Device.manufactureDate | |
Definition | The date and time when the device was manufactured. |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Device.expirationDate | |
Definition | The date and time beyond which this device is no longer valid or should not be used (if applicable). |
Cardinality | 0...1 |
Type | dateTime |
Invariants |
|
Mappings |
|
Device.lotNumber | |
Definition | Lot number assigned by the manufacturer. |
Cardinality | 0...1 |
Type | string |
Invariants |
|
Mappings |
|
Device.serialNumber | |
Definition | The serial number assigned by the organization when the device was manufactured. |
Cardinality | 0...1 |
Type | string |
Comments | Alphanumeric Maximum 20. |
Invariants |
|
Mappings |
|
Device.deviceName | |
Definition | This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition. |
Cardinality | 1...* |
Type | BackboneElement |
Invariants |
|
Device.deviceName.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Device.deviceName.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.deviceName.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.deviceName.name | |
Definition | The name of the device. |
Cardinality | 1...1 |
Type | string |
Alias | Σ |
Invariants |
|
Device.deviceName.type | |
Definition | The type of deviceName. UDILabelName | UserFriendlyName | PatientReportedName | ManufactureDeviceName | ModelName. |
Cardinality | 1...1 |
Type | code |
Binding | The type of name the device is referred by. |
Invariants |
|
Mappings |
|
Device.modelNumber | |
Definition | The model number for the device. |
Cardinality | 0...1 |
Type | string |
Invariants |
|
Mappings |
|
Device.partNumber | |
Definition | The part number of the device. |
Cardinality | 0...1 |
Type | string |
Comments | Alphanumeric Maximum 20. |
Invariants |
|
Mappings |
|
Device.type | |
Definition | The kind or type of device. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Codes to identify medical devices. |
Invariants |
|
Device.type.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Device.type.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Device.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. PHI 에서 활용하는 프로젝트의 경우 http://connectdtx.kr/fhir/CodeSystem/connectdtx-device-type을 고정값으로 활용해야한다. |
Invariants |
|
Mappings |
|
Device.type.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Device.type.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
Device.type.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Fixed Value | http://connectdtx.kr/fhir/CodeSystem/connectdtx-device-type |
Mappings |
|
Device.type.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
Device.type.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
Device.type.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
Device.type.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
Device.type.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
Device.specialization | |
Definition | The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Device.specialization.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Device.specialization.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.specialization.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.specialization.systemType | |
Definition | The standard that is used to operate and communicate. |
Cardinality | 1...1 |
Type | CodeableConcept |
Alias | Σ |
Invariants |
|
Device.specialization.version | |
Definition | The version of the standard that is used to operate and communicate. |
Cardinality | 0...1 |
Type | string |
Invariants |
|
Mappings |
|
Device.version | |
Definition | The actual design of the device or software version running on the device. |
Cardinality | 1...1 |
Type | BackboneElement |
Invariants |
|
Device.version.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Device.version.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.version.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.version.type | |
Definition | The type of the device version. |
Cardinality | 1...1 |
Type | CodeableConcept |
Alias | Σ |
Invariants |
|
Device.version.component | |
Definition | A single component of the device version. |
Cardinality | 0...1 |
Type | Identifier |
Invariants |
|
Mappings |
|
Device.version.value | |
Definition | The version text. |
Cardinality | 1...1 |
Type | string |
Invariants |
|
Device.property | |
Definition | The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties. |
Cardinality | 0...* |
Type | BackboneElement |
Invariants |
|
Device.property.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
Device.property.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.property.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
Device.property.type | |
Definition | Code that specifies the property DeviceDefinitionPropetyCode (Extensible). |
Cardinality | 1...1 |
Type | CodeableConcept |
Invariants |
|
Device.property.valueQuantity | |
Definition | Property value as a quantity. |
Cardinality | 0...* |
Type | Quantity |
Invariants |
|
Device.property.valueCode | |
Definition | Property value as a code, e.g., NTP4 (synced to NTP). |
Cardinality | 0...* |
Type | CodeableConcept |
Invariants |
|
Device.patient | |
Definition | Patient information, If the device is affixed to a person. |
Cardinality | 1...1 |
Type | Reference(KRCore_Patient) |
Requirements | If the device is implanted in a patient, then need to associate the device to the patient. |
Invariants |
|
Mappings |
|
Device.owner | |
Definition | An organization that is responsible for the provision and ongoing maintenance of the device. |
Cardinality | 1...1 |
Type | Reference(KRCore_HealthcareOrganization) |
Invariants |
|
Mappings |
|
Device.contact | |
Definition | Contact details for an organization or a particular human that is responsible for the device. |
Cardinality | 0...* |
Type | ContactPoint |
Comments | used for troubleshooting etc. |
Invariants |
|
Mappings |
|
Device.location | |
Definition | The place where the device can be found. |
Cardinality | 0...1 |
Type | Reference(Location) |
Requirements | Device.location can be used to track device location. |
Invariants |
|
Mappings |
|
Device.url | |
Definition | A network address on which the device may be contacted directly. |
Cardinality | 0...1 |
Type | uri |
Comments | If the device is running a FHIR server, the network address should be the Base URL from which a conformance statement may be retrieved. |
Invariants |
|
Mappings |
|
Device.note | |
Definition | Descriptive information, usage information or implantation information that is not captured in an existing element. |
Cardinality | 0...* |
Type | Annotation |
Invariants |
|
Mappings |
|
Device.safety | |
Definition | Provides additional safety characteristics about a medical device. For example devices containing latex. |
Cardinality | 0...* |
Type | CodeableConcept |
Summary | True |
Invariants |
|
Mappings |
|
Device.parent | |
Definition | The parent device. |
Cardinality | 0...1 |
Type | Reference(Device) |
Invariants |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="svccore-device" /> <url value="http://phis.co.kr/fhir/StructureDefinition/StructureDefinition-svccore-device" /> <version value="0.0.1" /> <name value="SvcCore_Device" /> <title value="Service Core Device Profile" /> <status value="active" /> <date value="2023-11-03T07:02:34.5600462+00:00" /> <description value="2023. 10. Device의 대한 최소규격의 대하여 정의" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="Device" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/Device" /> <derivation value="constraint" /> <differential> <element id="Device.identifier"> <path value="Device.identifier" /> <min value="1" /> <mustSupport value="false" /> </element> <element id="Device.identifier.system"> <path value="Device.identifier.system" /> <definition value="Establishes the namespace for the value - that is, a URL that describes a set values that are unique.\n\n연세의료원 주관 DTx 플랫폼 사업의 경우 https://connectdtx.net/phicode 을 고정값으로 활용." /> <min value="1" /> <example> <label value="PHI_CODE 식별체계 식별자" /> <valueUri value="https://connectdtx.net/phicode" /> </example> </element> <element id="Device.identifier.value"> <path value="Device.identifier.value" /> <definition value="The portion of the identifier typically relevant to the user and which is unique within the context of the system.\n\n연세의료원 주관 DTx 플랫폼 사업의 경우 PHI_CODE 식별체계 식별자 활용" /> <min value="1" /> </element> <element id="Device.manufacturer"> <path value="Device.manufacturer" /> <min value="1" /> </element> <element id="Device.deviceName"> <path value="Device.deviceName" /> <min value="1" /> </element> <element id="Device.type"> <path value="Device.type" /> <min value="1" /> </element> <element id="Device.type.coding"> <path value="Device.type.coding" /> <comment value="Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.\n\nPHI 에서 활용하는 프로젝트의 경우 http://connectdtx.kr/fhir/CodeSystem/connectdtx-device-type을 고정값으로 활용해야한다." /> <min value="1" /> </element> <element id="Device.type.coding.system"> <path value="Device.type.coding.system" /> <min value="1" /> <fixedUri value="http://connectdtx.kr/fhir/CodeSystem/connectdtx-device-type" /> </element> <element id="Device.type.coding.code"> <path value="Device.type.coding.code" /> <min value="1" /> </element> <element id="Device.version"> <path value="Device.version" /> <min value="1" /> <max value="1" /> </element> <element id="Device.version.type"> <path value="Device.version.type" /> <min value="1" /> </element> <element id="Device.patient"> <path value="Device.patient" /> <min value="1" /> <type> <code value="Reference" /> <targetProfile value="http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-patient" /> </type> </element> <element id="Device.owner"> <path value="Device.owner" /> <min value="1" /> <type> <code value="Reference" /> <targetProfile value="http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-healthcare-organization" /> </type> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "svccore-device", "url": "http://phis.co.kr/fhir/StructureDefinition/StructureDefinition-svccore-device", "version": "0.0.1", "name": "SvcCore_Device", "title": "Service Core Device Profile", "status": "active", "date": "11/03/2023 07:02:34", "description": "2023. 10. Device의 대한 최소규격의 대하여 정의", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "Device", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Device", "derivation": "constraint", "differential": { "element": [ { "id": "Device.identifier", "path": "Device.identifier", "min": 1, "mustSupport": false }, { "id": "Device.identifier.system", "path": "Device.identifier.system", "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.\n\n연세의료원 주관 DTx 플랫폼 사업의 경우 https://connectdtx.net/phicode 을 고정값으로 활용.", "min": 1, "example": [ { "label": "PHI_CODE 식별체계 식별자", "valueUri": "https://connectdtx.net/phicode" } ] }, { "id": "Device.identifier.value", "path": "Device.identifier.value", "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.\n\n연세의료원 주관 DTx 플랫폼 사업의 경우 PHI_CODE 식별체계 식별자 활용", "min": 1 }, { "id": "Device.manufacturer", "path": "Device.manufacturer", "min": 1 }, { "id": "Device.deviceName", "path": "Device.deviceName", "min": 1 }, { "id": "Device.type", "path": "Device.type", "min": 1 }, { "id": "Device.type.coding", "path": "Device.type.coding", "comment": "Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.\n\nPHI 에서 활용하는 프로젝트의 경우 http://connectdtx.kr/fhir/CodeSystem/connectdtx-device-type을 고정값으로 활용해야한다.", "min": 1 }, { "id": "Device.type.coding.system", "path": "Device.type.coding.system", "min": 1, "fixedUri": "http://connectdtx.kr/fhir/CodeSystem/connectdtx-device-type" }, { "id": "Device.type.coding.code", "path": "Device.type.coding.code", "min": 1 }, { "id": "Device.version", "path": "Device.version", "min": 1, "max": "1" }, { "id": "Device.version.type", "path": "Device.version.type", "min": 1 }, { "id": "Device.patient", "path": "Device.patient", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-patient" ] } ] }, { "id": "Device.owner", "path": "Device.owner", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-healthcare-organization" ] } ] } ] } }
DeviceMetric
평화이즈에서 자체적으로 정의한 Device Metric 입니다.
세부적인 사항은 아래의 디테일을 확인하여 구현해주세요.
SvcCore_DeviceMetric (DeviceMetric) | I | DeviceMetric | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 1..* | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
type | S Σ | 1..1 | CodeableConceptBinding |
unit | S Σ | 0..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 0..* | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 0..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
source | Σ | 1..1 | Reference(Device) |
parent | Σ | 1..1 | Reference(Device) |
operationalStatus | Σ | 0..1 | codeBinding |
color | Σ | 0..1 | codeBinding |
category | Σ | 1..1 | codeBinding |
measurementPeriod | Σ | 0..1 | Timing |
calibration | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
type | Σ | 0..1 | codeBinding |
state | Σ | 0..1 | codeBinding |
time | Σ | 0..1 | instant |
DeviceMetric | |
Definition | Describes a measurement, calculation or setting capability of a medical device. |
Cardinality | 0...* |
Comments | For the initial scope, this DeviceMetric resource is only applicable to describe a single metric node in the containment tree that is produced by the context scanner in any medical device that implements or derives from the ISO/IEEE 11073 standard. |
Invariants |
|
Mappings |
|
DeviceMetric.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
DeviceMetric.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
DeviceMetric.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
DeviceMetric.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
DeviceMetric.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
DeviceMetric.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
DeviceMetric.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DeviceMetric.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DeviceMetric.identifier | |
Definition | Unique instance identifiers assigned to a device by the device or gateway software, manufacturers, other organizations or owners. For example: handle ID. |
Cardinality | 1...* |
Type | Identifier |
Summary | True |
Comments | For identifiers assigned to a device by the device or gateway software, the |
Invariants |
|
Mappings |
|
DeviceMetric.identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DeviceMetric.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DeviceMetric.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
DeviceMetric.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
DeviceMetric.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient |
Mappings |
|
DeviceMetric.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
DeviceMetric.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
DeviceMetric.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
DeviceMetric.type | |
Definition | Describes the type of the metric. For example: Heart Rate, PEEP Setting, etc. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Describes the metric type. |
Must Support | True |
Summary | True |
Comments | DeviceMetric.type can be referred to either IEEE 11073-10101 or LOINC. |
Invariants |
|
Mappings |
|
DeviceMetric.unit | |
Definition | Describes the unit that an observed value determined for this metric will have. For example: Percent, Seconds, etc. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Describes the unit of the metric. |
Must Support | True |
Summary | True |
Comments | DeviceMetric.unit can refer to either UCUM or preferable a RTMMS coding system. |
Invariants |
|
DeviceMetric.unit.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DeviceMetric.unit.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DeviceMetric.unit.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 0...* |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
DeviceMetric.unit.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DeviceMetric.unit.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DeviceMetric.unit.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. referenced By http://hl7.org/fhir/ValueSet/devicemetric-type |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
DeviceMetric.unit.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
DeviceMetric.unit.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 0...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
DeviceMetric.unit.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
DeviceMetric.unit.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
DeviceMetric.unit.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
DeviceMetric.source | |
Definition | Describes the link to the Device that this DeviceMetric belongs to and that contains administrative device information such as manufacturer, serial number, etc. |
Cardinality | 1...1 |
Type | Reference(Device) |
Summary | True |
Invariants |
|
DeviceMetric.parent | |
Definition | Describes the link to the Device that this DeviceMetric belongs to and that provide information about the location of this DeviceMetric in the containment structure of the parent Device. An example would be a Device that represents a Channel. This reference can be used by a client application to distinguish DeviceMetrics that have the same type, but should be interpreted based on their containment location. |
Cardinality | 1...1 |
Type | Reference(Device) |
Summary | True |
Invariants |
|
DeviceMetric.operationalStatus | |
Definition | Indicates current operational state of the device. For example: On, Off, Standby, etc. |
Cardinality | 0...1 |
Type | code |
Binding | Describes the operational status of the DeviceMetric. |
Summary | True |
Invariants |
|
DeviceMetric.color | |
Definition | Describes the color representation for the metric. This is often used to aid clinicians to track and identify parameter types by color. In practice, consider a Patient Monitor that has ECG/HR and Pleth for example; the parameters are displayed in different characteristic colors, such as HR-blue, BP-green, and PR and SpO2- magenta. |
Cardinality | 0...1 |
Type | code |
Binding | Describes the typical color of representation. |
Summary | True |
Invariants |
|
DeviceMetric.category | |
Definition | Indicates the category of the observation generation process. A DeviceMetric can be for example a setting, measurement, or calculation. |
Cardinality | 1...1 |
Type | code |
Binding | Describes the category of the metric. |
Summary | True |
Invariants |
|
Mappings |
|
DeviceMetric.measurementPeriod | |
Definition | Describes the measurement repetition time. This is not necessarily the same as the update period. The measurement repetition time can range from milliseconds up to hours. An example for a measurement repetition time in the range of milliseconds is the sampling rate of an ECG. An example for a measurement repetition time in the range of hours is a NIBP that is triggered automatically every hour. The update period may be different than the measurement repetition time, if the device does not update the published observed value with the same frequency as it was measured. |
Cardinality | 0...1 |
Type | Timing |
Summary | True |
Invariants |
|
DeviceMetric.calibration | |
Definition | Describes the calibrations that have been performed or that are required to be performed. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Invariants |
|
DeviceMetric.calibration.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DeviceMetric.calibration.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DeviceMetric.calibration.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DeviceMetric.calibration.type | |
Definition | Describes the type of the calibration method. |
Cardinality | 0...1 |
Type | code |
Binding | Describes the type of a metric calibration. |
Summary | True |
Invariants |
|
DeviceMetric.calibration.state | |
Definition | Describes the state of the calibration. |
Cardinality | 0...1 |
Type | code |
Binding | Describes the state of a metric calibration. |
Summary | True |
Invariants |
|
DeviceMetric.calibration.time | |
Definition | Describes the time last calibration has been performed. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Invariants |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="svccore-devicemetric" /> <url value="http://phis.co.kr/fhir/StructureDefinition/StructureDefinition-svccore-devicemetric" /> <version value="0.0.1" /> <name value="SvcCore_DeviceMetric" /> <title value="Service Core DeviceMetric Profile" /> <status value="active" /> <date value="2023-10-30T01:53:15.6881432+00:00" /> <publisher value="PHIS" /> <description value="2023. 10. DeviceMetric의 대한 최소규격의 대하여 정의" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="DeviceMetric" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DeviceMetric" /> <derivation value="constraint" /> <differential> <element id="DeviceMetric.identifier"> <path value="DeviceMetric.identifier" /> <min value="1" /> </element> <element id="DeviceMetric.identifier.system"> <path value="DeviceMetric.identifier.system" /> <min value="1" /> </element> <element id="DeviceMetric.identifier.value"> <path value="DeviceMetric.identifier.value" /> <min value="1" /> </element> <element id="DeviceMetric.type"> <path value="DeviceMetric.type" /> <mustSupport value="true" /> </element> <element id="DeviceMetric.unit"> <path value="DeviceMetric.unit" /> <mustSupport value="true" /> </element> <element id="DeviceMetric.unit.coding.system"> <path value="DeviceMetric.unit.coding.system" /> <definition value="The identification of the code system that defines the meaning of the symbol in the code.\n\nreferenced By http://hl7.org/fhir/ValueSet/devicemetric-type" /> <min value="1" /> <meaningWhenMissing value="디바이스메트릭에서 Unit에 들어가는 Coding 값이 존재할때 해당 디바이스메트릭은 반드시 System을 필요로 합니다." /> </element> <element id="DeviceMetric.source"> <path value="DeviceMetric.source" /> <min value="1" /> </element> <element id="DeviceMetric.parent"> <path value="DeviceMetric.parent" /> <min value="1" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "svccore-devicemetric", "url": "http://phis.co.kr/fhir/StructureDefinition/StructureDefinition-svccore-devicemetric", "version": "0.0.1", "name": "SvcCore_DeviceMetric", "title": "Service Core DeviceMetric Profile", "status": "active", "date": "10/30/2023 01:53:15", "publisher": "PHIS", "description": "2023. 10. DeviceMetric의 대한 최소규격의 대하여 정의", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "DeviceMetric", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DeviceMetric", "derivation": "constraint", "differential": { "element": [ { "id": "DeviceMetric.identifier", "path": "DeviceMetric.identifier", "min": 1 }, { "id": "DeviceMetric.identifier.system", "path": "DeviceMetric.identifier.system", "min": 1 }, { "id": "DeviceMetric.identifier.value", "path": "DeviceMetric.identifier.value", "min": 1 }, { "id": "DeviceMetric.type", "path": "DeviceMetric.type", "mustSupport": true }, { "id": "DeviceMetric.unit", "path": "DeviceMetric.unit", "mustSupport": true }, { "id": "DeviceMetric.unit.coding.system", "path": "DeviceMetric.unit.coding.system", "definition": "The identification of the code system that defines the meaning of the symbol in the code.\n\nreferenced By http://hl7.org/fhir/ValueSet/devicemetric-type", "min": 1, "meaningWhenMissing": "디바이스메트릭에서 Unit에 들어가는 Coding 값이 존재할때 해당 디바이스메트릭은 반드시 System을 필요로 합니다." }, { "id": "DeviceMetric.source", "path": "DeviceMetric.source", "min": 1 }, { "id": "DeviceMetric.parent", "path": "DeviceMetric.parent", "min": 1 } ] } }
DocumentReference
평화이즈에서 자체적으로 정의한 Document Reference 입니다.
세부적인 사항은 아래의 디테일을 확인하여 구현해주세요.
SvcCore_DocumentReference (DocumentReference) | I | DocumentReference | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
masterIdentifier | Σ | 0..1 | Identifier |
identifier | Σ | 1..* | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
status | Σ ?! | 1..1 | codeBinding |
docStatus | Σ | 0..1 | codeBinding |
type | Σ | 1..1 | CodeableConceptBinding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 1..1 | Coding |
text | Σ | 0..1 | string |
category | Σ | 0..* | CodeableConcept |
subject | Σ | 1..1 | Reference(KRCore_Patient) |
date | Σ | 0..1 | instant |
author | Σ | 1..* | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | SvcCore_Device) |
authenticator | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | |
custodian | 0..1 | Reference(Organization) | |
relatesTo | Σ | 0..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
code | Σ | 1..1 | codeBinding |
target | Σ | 1..1 | Reference(DocumentReference) |
description | Σ | 0..1 | string |
securityLabel | Σ | 0..* | CodeableConceptBinding |
content | Σ | 1..* | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
attachment | Σ | 1..1 | Attachment |
format | Σ | 0..1 | CodingBinding |
context | Σ | 1..1 | BackboneElement |
id | 0..1 | string | |
extension | I | 0..* | Extension |
modifierExtension | Σ ?! I | 0..* | Extension |
encounter | 0..* | Reference(Encounter | EpisodeOfCare) | |
event | 0..* | CodeableConcept | |
period | Σ | 1..1 | Period |
id | 0..1 | string | |
extension | I | 0..* | Extension |
start | Σ I | 1..1 | dateTime |
end | Σ I | 0..1 | dateTime |
facilityType | 0..1 | CodeableConcept | |
practiceSetting | 0..1 | CodeableConcept | |
sourcePatientInfo | 0..1 | Reference(Patient) | |
related | 0..* | Reference(Resource) |
DocumentReference | |
Definition | A reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any seralized object with a mime-type, so includes formal patient centric documents (CDA), cliical notes, scanned paper, and non-patient specific documents like policy text. |
Cardinality | 0...* |
Comments | Usually, this is used for documents other than those defined by FHIR. |
Invariants |
|
Mappings |
|
DocumentReference.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
DocumentReference.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
DocumentReference.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
DocumentReference.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
DocumentReference.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
DocumentReference.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
DocumentReference.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DocumentReference.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DocumentReference.masterIdentifier | |
Definition | Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Requirements | The structure and format of this Id shall be consistent with the specification corresponding to the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization of the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.). |
Comments | CDA Document Id extension and root. |
Invariants |
|
Mappings |
|
DocumentReference.identifier | |
Definition | Other identifiers associated with the document, including version independent identifiers. |
Cardinality | 1...* |
Type | Identifier |
Summary | True |
Invariants |
|
Mappings |
|
DocumentReference.identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DocumentReference.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DocumentReference.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
DocumentReference.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
DocumentReference.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. Dtx 활용 시 https://connectdtx.net/phicode 를 고정값으로 활용. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient phi-code https://connectdtx.net/phicode |
Mappings |
|
DocumentReference.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
DocumentReference.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
DocumentReference.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
DocumentReference.status | |
Definition | The status of this document reference. |
Cardinality | 1...1 |
Type | code |
Binding | The status of the document reference. |
Modifier | True |
Summary | True |
Comments | This is the status of the DocumentReference object, which might be independent from the docStatus element. This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid. |
Invariants |
|
Mappings |
|
DocumentReference.docStatus | |
Definition | The status of the underlying document. |
Cardinality | 0...1 |
Type | code |
Binding | Status of the underlying document. |
Summary | True |
Comments | The document that is pointed to might be in various lifecycle states. |
Invariants |
|
Mappings |
|
DocumentReference.type | |
Definition | Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Precise type of clinical document. |
Summary | True |
Comments | Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents. |
Invariants |
|
Mappings |
|
DocumentReference.type.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DocumentReference.type.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DocumentReference.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
DocumentReference.type.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
DocumentReference.category | |
Definition | A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | High-level kind of a clinical document at a macro level. |
Summary | True |
Alias | claxs |
Comments | Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching. |
Invariants |
|
Mappings |
|
DocumentReference.subject | |
Definition | Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). |
Cardinality | 1...1 |
Type | Reference(KRCore_Patient) |
Summary | True |
Invariants |
|
Mappings |
|
DocumentReference.date | |
Definition | When the document reference was created. |
Cardinality | 0...1 |
Type | instant |
Summary | True |
Alias | indexed |
Comments | Referencing/indexing time is used for tracking, organizing versions and searching. |
Invariants |
|
Mappings |
|
DocumentReference.author | |
Definition | Identifies who is responsible for adding the information to the document. |
Cardinality | 1...* |
Type | Reference(Practitioner | PractitionerRole | Organization | Patient | RelatedPerson | SvcCore_Device) |
Summary | True |
Comments | Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant). |
Invariants |
|
Mappings |
|
DocumentReference.authenticator | |
Definition | Which person or organization authenticates that this document is valid. |
Cardinality | 0...1 |
Type | Reference(Practitioner | PractitionerRole | Organization) |
Comments | Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator. |
Invariants |
|
Mappings |
|
DocumentReference.custodian | |
Definition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Comments | Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization. |
Invariants |
|
Mappings |
|
DocumentReference.relatesTo | |
Definition | Relationships that this document has with other document references that already exist. |
Cardinality | 0...* |
Type | BackboneElement |
Summary | True |
Comments | This element is labeled as a modifier because documents that append to other documents are incomplete on their own. |
Invariants |
|
Mappings |
|
DocumentReference.relatesTo.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DocumentReference.relatesTo.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DocumentReference.relatesTo.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DocumentReference.relatesTo.code | |
Definition | The type of relationship that this document has with anther document. |
Cardinality | 1...1 |
Type | code |
Binding | The type of relationship between documents. |
Summary | True |
Comments | If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. |
Invariants |
|
Mappings |
|
DocumentReference.relatesTo.target | |
Definition | The target document of this relationship. |
Cardinality | 1...1 |
Type | Reference(DocumentReference) |
Summary | True |
Invariants |
|
Mappings |
|
DocumentReference.description | |
Definition | Human-readable description of the source document. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Helps humans to assess whether the document is of interest. |
Comments | What the document is about, a terse summary of the document. |
Invariants |
|
Mappings |
|
DocumentReference.securityLabel | |
Definition | A set of Security-Tag codes specifying the level of privacy/security of the Document. Note that DocumentReference.meta.security contains the security labels of the "reference" to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on the document the reference refers to. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Security Labels from the Healthcare Privacy and Security Classification System. |
Summary | True |
Requirements | Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended. |
Comments | The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects. |
Invariants |
|
Mappings |
|
DocumentReference.content | |
Definition | The document and format referenced. There may be multiple content element repetitions, each with a different format. |
Cardinality | 1...* |
Type | BackboneElement |
Summary | True |
Invariants |
|
Mappings |
|
DocumentReference.content.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DocumentReference.content.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DocumentReference.content.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DocumentReference.content.attachment | |
Definition | The document or URL of the document along with critical metadata to prove content has integrity. |
Cardinality | 1...1 |
Type | Attachment |
Summary | True |
Invariants |
|
Mappings |
|
DocumentReference.content.format | |
Definition | An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. |
Cardinality | 0...1 |
Type | Coding |
Binding | Document Format Codes. |
Summary | True |
Comments | Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI. |
Invariants |
|
Mappings |
|
DocumentReference.context | |
Definition | The clinical context in which the document was prepared. |
Cardinality | 1...1 |
Type | BackboneElement |
Summary | True |
Comments | These values are primarily added to help with searching for interesting/relevant documents. |
Invariants |
|
Mappings |
|
DocumentReference.context.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DocumentReference.context.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DocumentReference.context.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Summary | True |
Alias | extensions, user content, modifiers |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
DocumentReference.context.encounter | |
Definition | Describes the clinical encounter or type of care that the document content is associated with. |
Cardinality | 0...* |
Type | Reference(Encounter | EpisodeOfCare) |
Invariants |
|
Mappings |
|
DocumentReference.context.event | |
Definition | This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is inherent in the type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | This list of codes represents the main clinical acts being documented. |
Comments | An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation. |
Invariants |
|
Mappings |
|
DocumentReference.context.period | |
Definition | The time period over which the service that is described by the document was provided. |
Cardinality | 1...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
DocumentReference.context.period.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
DocumentReference.context.period.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
DocumentReference.context.period.start | |
Definition | The start of the period. The boundary is inclusive. |
Cardinality | 1...1 |
Type | dateTime |
Summary | True |
Comments | If the low element is missing, the meaning is that the low boundary is not known. |
Invariants |
|
Mappings |
|
DocumentReference.context.period.end | |
Definition | The end of the period. If the end of the period is missing, it means no end was known or planned at the time the instance was created. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Comments | The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has an end value of 2012-02-03. |
Invariants |
|
Mappings |
|
DocumentReference.context.facilityType | |
Definition | The kind of facility where the patient was seen. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | XDS Facility Type. |
Invariants |
|
Mappings |
|
DocumentReference.context.practiceSetting | |
Definition | This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Additional details about where the content was created (e.g. clinical specialty). |
Requirements | This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content. |
Comments | This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC. |
Invariants |
|
Mappings |
|
DocumentReference.context.sourcePatientInfo | |
Definition | The Patient Information as known when the document was published. May be a reference to a version specific, or contained. |
Cardinality | 0...1 |
Type | Reference(Patient) |
Invariants |
|
Mappings |
|
DocumentReference.context.related | |
Definition | Related identifiers or resources associated with the DocumentReference. |
Cardinality | 0...* |
Type | Reference(Resource) |
Comments | May be identifiers or resources that caused the DocumentReference or referenced Document to be created. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="svccore-documentreference" /> <url value="http://phis.co.kr/fhir/StructureDefinition/StructureDefinition-svccore-documentreference" /> <version value="0.0.1" /> <name value="SvcCore_DocumentReference" /> <title value="Service Core DocumentReference Profile" /> <status value="active" /> <date value="2023-10-30T01:53:15.6881432+00:00" /> <description value="2023. 10. DocumentReference의 대한 최소규격의 대하여 정의" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="DocumentReference" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/DocumentReference" /> <derivation value="constraint" /> <differential> <element id="DocumentReference.identifier"> <path value="DocumentReference.identifier" /> <min value="1" /> </element> <element id="DocumentReference.identifier.system"> <path value="DocumentReference.identifier.system" /> <definition value="Establishes the namespace for the value - that is, a URL that describes a set values that are unique.\n\nDtx 활용 시 https://connectdtx.net/phicode 를 고정값으로 활용." /> <min value="1" /> <example> <label value="phi-code" /> <valueUri value="https://connectdtx.net/phicode" /> </example> </element> <element id="DocumentReference.identifier.value"> <path value="DocumentReference.identifier.value" /> <definition value="The portion of the identifier typically relevant to the user and which is unique within the context of the system." /> <min value="1" /> </element> <element id="DocumentReference.type"> <path value="DocumentReference.type" /> <min value="1" /> </element> <element id="DocumentReference.type.coding"> <path value="DocumentReference.type.coding" /> <min value="1" /> <max value="1" /> </element> <element id="DocumentReference.subject"> <path value="DocumentReference.subject" /> <min value="1" /> <type> <code value="Reference" /> <targetProfile value="http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-patient" /> </type> </element> <element id="DocumentReference.author"> <path value="DocumentReference.author" /> <min value="1" /> <type> <code value="Reference" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Practitioner" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/PractitionerRole" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Organization" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/Patient" /> <targetProfile value="http://hl7.org/fhir/StructureDefinition/RelatedPerson" /> <targetProfile value="http://phis.co.kr/fhir/StructureDefinition/StructureDefinition-svccore-device" /> </type> </element> <element id="DocumentReference.context"> <path value="DocumentReference.context" /> <min value="1" /> </element> <element id="DocumentReference.context.period"> <path value="DocumentReference.context.period" /> <min value="1" /> </element> <element id="DocumentReference.context.period.start"> <path value="DocumentReference.context.period.start" /> <min value="1" /> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "svccore-documentreference", "url": "http://phis.co.kr/fhir/StructureDefinition/StructureDefinition-svccore-documentreference", "version": "0.0.1", "name": "SvcCore_DocumentReference", "title": "Service Core DocumentReference Profile", "status": "active", "date": "10/30/2023 01:53:15", "description": "2023. 10. DocumentReference의 대한 최소규격의 대하여 정의", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "DocumentReference", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/DocumentReference", "derivation": "constraint", "differential": { "element": [ { "id": "DocumentReference.identifier", "path": "DocumentReference.identifier", "min": 1 }, { "id": "DocumentReference.identifier.system", "path": "DocumentReference.identifier.system", "definition": "Establishes the namespace for the value - that is, a URL that describes a set values that are unique.\n\nDtx 활용 시 https://connectdtx.net/phicode 를 고정값으로 활용.", "min": 1, "example": [ { "label": "phi-code", "valueUri": "https://connectdtx.net/phicode" } ] }, { "id": "DocumentReference.identifier.value", "path": "DocumentReference.identifier.value", "definition": "The portion of the identifier typically relevant to the user and which is unique within the context of the system.", "min": 1 }, { "id": "DocumentReference.type", "path": "DocumentReference.type", "min": 1 }, { "id": "DocumentReference.type.coding", "path": "DocumentReference.type.coding", "min": 1, "max": "1" }, { "id": "DocumentReference.subject", "path": "DocumentReference.subject", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-patient" ] } ] }, { "id": "DocumentReference.author", "path": "DocumentReference.author", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole", "http://hl7.org/fhir/StructureDefinition/Organization", "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/RelatedPerson", "http://phis.co.kr/fhir/StructureDefinition/StructureDefinition-svccore-device" ] } ] }, { "id": "DocumentReference.context", "path": "DocumentReference.context", "min": 1 }, { "id": "DocumentReference.context.period", "path": "DocumentReference.context.period", "min": 1 }, { "id": "DocumentReference.context.period.start", "path": "DocumentReference.context.period.start", "min": 1 } ] } }
ServiceRequest
평화이즈에서 자체적으로 정의한 Service Request 입니다.
세부적인 사항은 아래의 tree를 확인하여 구현해주세요.
SvcCore_ServiceRequest (ServiceRequest) | I | ServiceRequest | |
id | Σ | 0..1 | string |
meta | Σ | 0..1 | Meta |
implicitRules | Σ ?! | 0..1 | uri |
language | 0..1 | codeBinding | |
text | 0..1 | Narrative | |
contained | 0..* | Resource | |
extension | I | 0..* | Extension |
modifierExtension | ?! I | 0..* | Extension |
identifier | Σ | 1..* | Identifier |
id | 0..1 | string | |
extension | I | 0..* | Extension |
use | Σ ?! | 0..1 | codeBinding |
type | Σ | 0..1 | CodeableConceptBinding |
system | Σ | 1..1 | uri |
value | Σ | 1..1 | string |
period | Σ | 0..1 | Period |
assigner | Σ | 0..1 | Reference(Organization) |
instantiatesCanonical | Σ | 0..* | canonical(ActivityDefinition | PlanDefinition) |
instantiatesUri | Σ | 0..* | uri |
basedOn | Σ | 0..* | Reference(CarePlan | ServiceRequest | MedicationRequest) |
replaces | Σ | 0..* | Reference(ServiceRequest) |
requisition | Σ | 0..1 | Identifier |
status | Σ ?! | 1..1 | codeBinding |
intent | Σ ?! | 1..1 | codeBinding |
category | Σ | 0..* | CodeableConcept |
priority | Σ | 0..1 | codeBinding |
doNotPerform | Σ ?! | 0..1 | boolean |
code | Σ | 1..1 | CodeableConcept |
id | 0..1 | string | |
extension | I | 0..* | Extension |
coding | Σ | 1..1 | Coding |
id | 0..1 | string | |
extension | I | 0..* | Extension |
system | Σ | 1..1 | uri |
version | Σ | 0..1 | string |
code | Σ | 1..1 | code |
display | Σ | 0..1 | string |
userSelected | Σ | 0..1 | boolean |
text | Σ | 0..1 | string |
orderDetail | Σ I | 0..* | CodeableConcept |
quantity[x] | Σ | 0..1 | |
quantityQuantity | Quantity | ||
quantityRatio | Ratio | ||
quantityRange | Range | ||
subject | Σ | 1..1 | Reference(KRCore_Patient) |
encounter | Σ | 1..1 | Reference(KRCore_Encounter) |
occurrence[x] | Σ | 0..1 | |
occurrenceDateTime | dateTime | ||
occurrencePeriod | Period | ||
occurrenceTiming | Timing | ||
asNeeded[x] | Σ | 0..1 | |
asNeededBoolean | boolean | ||
asNeededCodeableConcept | CodeableConcept | ||
authoredOn | Σ | 0..1 | dateTime |
requester | Σ | 1..1 | Reference(KRCore_PractitionerRole_MedicalDoctor) |
performerType | Σ | 0..1 | CodeableConcept |
performer | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) |
locationCode | Σ | 0..* | CodeableConcept |
locationReference | Σ | 0..* | Reference(Location) |
reasonCode | Σ | 0..* | CodeableConcept |
reasonReference | Σ | 0..* | Reference(Condition | Observation | DiagnosticReport | DocumentReference) |
insurance | 0..* | Reference(Coverage | ClaimResponse) | |
supportingInfo | 0..* | Reference(Resource) | |
specimen | Σ | 0..* | Reference(Specimen) |
bodySite | Σ | 0..* | CodeableConcept |
note | 0..* | Annotation | |
patientInstruction | Σ | 0..1 | string |
relevantHistory | 0..* | Reference(Provenance) |
ServiceRequest | |
Definition | 진단 조사, 치료 또는 수술과 같은 서비스 요청의 기록입니다. |
Cardinality | 0...* |
Alias | diagnostic request, referral, referral request, transfer of care request |
Invariants |
|
Mappings |
|
ServiceRequest.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
ServiceRequest.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Cardinality | 0...1 |
Type | Meta |
Summary | True |
Invariants |
|
ServiceRequest.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Cardinality | 0...1 |
Type | uri |
Modifier | True |
Summary | True |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants |
|
ServiceRequest.language | |
Definition | The base language in which the resource is written. |
Cardinality | 0...1 |
Type | code |
Binding | A human language. |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Invariants |
|
ServiceRequest.text | |
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Cardinality | 0...1 |
Type | Narrative |
Alias | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Invariants |
|
Mappings |
|
ServiceRequest.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Cardinality | 0...* |
Type | Resource |
Alias | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
Mappings |
|
ServiceRequest.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
ServiceRequest.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Cardinality | 0...* |
Type | Extension |
Modifier | True |
Alias | extensions, user content |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants |
|
Mappings |
|
ServiceRequest.identifier | |
Definition | Identifiers assigned to this order instance by the orderer and/or the receiver and/or order fulfiller. |
Cardinality | 1...* |
Type | Identifier |
Summary | True |
Comments | The identifier.type element is used to distinguish between the identifiers assigned by the orderer (known as the 'Placer' in HL7 v2) and the producer of the observations in response to the order (known as the 'Filler' in HL7 v2). For further discussion and examples see the resource notes section below. |
Invariants |
|
Mappings |
|
ServiceRequest.identifier.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
ServiceRequest.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
ServiceRequest.identifier.use | |
Definition | The purpose of this identifier. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the purpose for this identifier, if known . |
Modifier | True |
Summary | True |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Invariants |
|
Mappings |
|
ServiceRequest.identifier.type | |
Definition | A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. |
Summary | True |
Requirements | Allows users to make use of identifiers when the identifier system is not known. |
Comments | This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Invariants |
|
Mappings |
|
ServiceRequest.identifier.system | |
Definition | Establishes the namespace for the value - that is, a URL that describes a set values that are unique. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers. |
Comments | Identifier.system is always case sensitive. |
Invariants |
|
Examples | General http://www.acme.com/identifiers/patient |
Mappings |
|
ServiceRequest.identifier.value | |
Definition | The portion of the identifier typically relevant to the user and which is unique within the context of the system. |
Cardinality | 1...1 |
Type | string |
Summary | True |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe. |
Invariants |
|
Examples | General 123456 |
Mappings |
|
ServiceRequest.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Cardinality | 0...1 |
Type | Period |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Cardinality | 0...1 |
Type | Reference(Organization) |
Summary | True |
Comments | The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization. |
Invariants |
|
Mappings |
|
ServiceRequest.instantiatesCanonical | |
Definition | The URL pointing to a FHIR-defined protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. |
Cardinality | 0...* |
Type | canonical(ActivityDefinition | PlanDefinition) |
Summary | True |
Comments | Note: This is a business identifier, not a resource identifier (see discussion). It is best practice for the identifier to only appear on a single resource instance, however business practices may occasionally dictate that multiple resource instances with the same identifier can exist - possibly even with different resource types. For example, multiple Patient and a Person resource instance might share the same social insurance number. |
Invariants |
|
Mappings |
|
ServiceRequest.instantiatesUri | |
Definition | The URL pointing to an externally maintained protocol, guideline, orderset or other definition that is adhered to in whole or in part by this ServiceRequest. |
Cardinality | 0...* |
Type | uri |
Summary | True |
Comments | This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier. |
Invariants |
|
Mappings |
|
ServiceRequest.basedOn | |
Definition | Plan/proposal/order fulfilled by this request. |
Cardinality | 0...* |
Type | Reference(CarePlan | ServiceRequest | MedicationRequest) |
Summary | True |
Alias | fulfills |
Invariants |
|
Mappings |
|
ServiceRequest.replaces | |
Definition | The request takes the place of the referenced completed or terminated request(s). |
Cardinality | 0...* |
Type | Reference(ServiceRequest) |
Summary | True |
Alias | supersedes, prior, renewed order |
Invariants |
|
Mappings |
|
ServiceRequest.requisition | |
Definition | A shared identifier common to all service requests that were authorized more or less simultaneously by a single author, representing the composite or group identifier. |
Cardinality | 0...1 |
Type | Identifier |
Summary | True |
Alias | grouperId, groupIdentifier |
Requirements | Some business processes need to know if multiple items were ordered as part of the same "requisition" for billing or other purposes. |
Comments | Requests are linked either by a "basedOn" relationship (i.e. one request is fulfilling another) or by having a common requisition. Requests that are part of the same requisition are generally treated independently from the perspective of changing their state or maintaining them after initial creation. |
Invariants |
|
Mappings |
|
ServiceRequest.status | |
Definition | The status of the order. |
Cardinality | 1...1 |
Type | code |
Binding | The status of a service order. |
Modifier | True |
Summary | True |
Comments | The status is generally fully in the control of the requester - they determine whether the order is draft or active and, after it has been activated, competed, cancelled or suspended. States relating to the activities of the performer are reflected on either the corresponding event (see Event Pattern for general discussion) or using the Task resource. |
Invariants |
|
Mappings |
|
ServiceRequest.intent | |
Definition | Whether the request is a proposal, plan, an original order or a reflex order. |
Cardinality | 1...1 |
Type | code |
Binding | The kind of service request. |
Modifier | True |
Summary | True |
Comments | This element is labeled as a modifier because the intent alters when and how the resource is actually applicable. |
Invariants |
|
Examples | PHIS_DTx order |
Mappings |
|
ServiceRequest.category | |
Definition | A code that classifies the service for searching, sorting and display purposes (e.g. "Surgical Procedure"). |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Classification of the requested service. |
Summary | True |
Requirements | Used for filtering what service request are retrieved and displayed. |
Comments | There may be multiple axis of categorization depending on the context or use case for retrieving or displaying the resource. The level of granularity is defined by the category concepts in the value set. |
Invariants |
|
Mappings |
|
ServiceRequest.priority | |
Definition | Indicates how quickly the ServiceRequest should be addressed with respect to other requests. |
Cardinality | 0...1 |
Type | code |
Binding | Identifies the level of importance to be assigned to actioning the request. |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.doNotPerform | |
Definition | Set this to true if the record is saying that the service/procedure should NOT be performed. |
Cardinality | 0...1 |
Type | boolean |
Modifier | True |
Summary | True |
Requirements | Used for do not ambulate, do not elevate head of bed, do not flush NG tube, do not take blood pressure on a certain arm, etc. |
Comments | In general, only the code and timeframe will be present, though occasional additional qualifiers such as body site or even performer could be included to narrow the scope of the prohibition. If the ServiceRequest.code and ServiceRequest.doNotPerform both contain negation, that will reinforce prohibition and should not have a double negative interpretation. |
Invariants |
|
Mappings |
|
ServiceRequest.code | |
Definition | A code that identifies a particular service (i.e., procedure, diagnostic investigation, or panel of investigations) that have been requested. |
Cardinality | 1...1 |
Type | CodeableConcept |
Binding | Codes for tests or services that can be carried out by a designated individual, organization or healthcare service. For laboratory, LOINC is (preferred)[http://build.fhir.org/terminologies.html#preferred] and a valueset using LOINC Order codes is available here. |
Summary | True |
Alias | service requested |
Comments | Many laboratory and radiology procedure codes embed the specimen/organ system in the test order name, for example, serum or serum/plasma glucose, or a chest x-ray. The specimen might not be recorded separately from the test code. |
Invariants |
|
Mappings |
|
ServiceRequest.code.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
ServiceRequest.code.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
ServiceRequest.code.coding | |
Definition | A reference to a code defined by a terminology system. |
Cardinality | 1...1 |
Type | Coding |
Summary | True |
Requirements | Allows for alternative encodings within a code system, and translations to other code systems. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true. |
Invariants |
|
Mappings |
|
ServiceRequest.code.coding.id | |
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
Cardinality | 0...1 |
Type | string |
Mappings |
|
ServiceRequest.code.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Cardinality | 0...* |
Type | Extension |
Alias | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Slicing | Unordered, Open, by url(Value) |
Invariants |
|
Mappings |
|
ServiceRequest.code.coding.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Cardinality | 1...1 |
Type | uri |
Summary | True |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Invariants |
|
Mappings |
|
ServiceRequest.code.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Invariants |
|
Mappings |
|
ServiceRequest.code.coding.code | |
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). |
Cardinality | 1...1 |
Type | code |
Summary | True |
Requirements | Need to refer to a particular code in the system. |
Invariants |
|
Mappings |
|
ServiceRequest.code.coding.display | |
Definition | A representation of the meaning of the code in the system, following the rules of the system. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Invariants |
|
Mappings |
|
ServiceRequest.code.coding.userSelected | |
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). |
Cardinality | 0...1 |
Type | boolean |
Summary | True |
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. |
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. |
Invariants |
|
Mappings |
|
ServiceRequest.code.text | |
Definition | A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Invariants |
|
Mappings |
|
ServiceRequest.orderDetail | |
Definition | Additional details and instructions about the how the services are to be delivered. For example, and order for a urinary catheter may have an order detail for an external or indwelling catheter, or an order for a bandage may require additional instructions specifying how the bandage should be applied. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codified order entry details which are based on order context. |
Summary | True |
Alias | detailed instructions |
Comments | For information from the medical record intended to support the delivery of the requested services, use the |
Invariants |
|
Mappings |
|
ServiceRequest.quantity[x] | |
Definition | An amount of service being requested which can be a quantity ( for example $1,500 home modification), a ratio ( for example, 20 half day visits per month), or a range (2.0 to 1.8 Gy per fraction). |
Cardinality | 0...1 |
Type | Quantity |
Summary | True |
Requirements | When ordering a service the number of service items may need to be specified separately from the the service item. |
Invariants |
|
Mappings |
|
ServiceRequest.subject | |
Definition | On whom or what the service is to be performed. This is usually a human patient, but can also be requested on animals, groups of humans or animals, devices such as dialysis machines, or even locations (typically for environmental scans). |
Cardinality | 1...1 |
Type | Reference(KRCore_Patient) |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.encounter | |
Definition | An encounter that provides additional information about the healthcare context in which this request is made. |
Cardinality | 1...1 |
Type | Reference(KRCore_Encounter) |
Summary | True |
Alias | context |
Invariants |
|
Mappings |
|
ServiceRequest.occurrence[x] | |
Definition | The date/time at which the requested service should occur. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Alias | schedule |
Invariants |
|
Mappings |
|
ServiceRequest.asNeeded[x] | |
Definition | If a CodeableConcept is present, it indicates the pre-condition for performing the service. For example "pain", "on flare-up", etc. |
Cardinality | 0...1 |
Type | boolean |
Binding | A coded concept identifying the pre-condition that should hold prior to performing a procedure. For example "pain", "on flare-up", etc. |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.authoredOn | |
Definition | When the request transitioned to being actionable. |
Cardinality | 0...1 |
Type | dateTime |
Summary | True |
Alias | orderedOn |
Invariants |
|
Mappings |
|
ServiceRequest.requester | |
Definition | The individual who initiated the request and has responsibility for its activation. |
Cardinality | 1...1 |
Type | Reference(KRCore_PractitionerRole_MedicalDoctor) |
Summary | True |
Alias | author, orderer |
Comments | This not the dispatcher, but rather who is the authorizer. This element is not intended to handle delegation which would generally be managed through the Provenance resource. |
Invariants |
|
Mappings |
|
ServiceRequest.performerType | |
Definition | Desired type of performer for doing the requested service. |
Cardinality | 0...1 |
Type | CodeableConcept |
Binding | Indicates specific responsibility of an individual within the care team, such as "Primary physician", "Team coordinator", "Caregiver", etc. |
Summary | True |
Alias | specialty |
Comments | This is a role, not a participation type. In other words, does not describe the task but describes the capacity. For example, “compounding pharmacy”, “psychiatrist” or “internal referral”. |
Invariants |
|
Mappings |
|
ServiceRequest.performer | |
Definition | The desired performer for doing the requested service. For example, the surgeon, dermatopathologist, endoscopist, etc. |
Cardinality | 0...* |
Type | Reference(Practitioner | PractitionerRole | Organization | CareTeam | HealthcareService | Patient | Device | RelatedPerson) |
Summary | True |
Alias | request recipient |
Comments | If multiple performers are present, it is interpreted as a list of alternative performers without any preference regardless of order. If order of preference is needed use the request-performerOrder extension. Use CareTeam to represent a group of performers (for example, Practitioner A and Practitioner B). |
Invariants |
|
Mappings |
|
ServiceRequest.locationCode | |
Definition | The preferred location(s) where the procedure should actually happen in coded or free text form. E.g. at home or nursing day care center. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | A location type where services are delivered. |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.locationReference | |
Definition | A reference to the the preferred location(s) where the procedure should actually happen. E.g. at home or nursing day care center. |
Cardinality | 0...* |
Type | Reference(Location) |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.reasonCode | |
Definition | An explanation or justification for why this service is being requested in coded or textual form. This is often for billing purposes. May relate to the resources referred to in `supportingInfo`. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Diagnosis or problem codes justifying the reason for requesting the service investigation. |
Summary | True |
Comments | This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. Use |
Invariants |
|
Mappings |
|
ServiceRequest.reasonReference | |
Definition | Indicates another resource that provides a justification for why this service is being requested. May relate to the resources referred to in `supportingInfo`. |
Cardinality | 0...* |
Type | Reference(Condition | Observation | DiagnosticReport | DocumentReference) |
Summary | True |
Comments | This element represents why the referral is being made and may be used to decide how the service will be performed, or even if it will be performed at all. To be as specific as possible, a reference to Observation or Condition should be used if available. Otherwise when referencing DiagnosticReport it should contain a finding in |
Invariants |
|
Mappings |
|
ServiceRequest.insurance | |
Definition | Insurance plans, coverage extensions, pre-authorizations and/or pre-determinations that may be needed for delivering the requested service. |
Cardinality | 0...* |
Type | Reference(Coverage | ClaimResponse) |
Invariants |
|
Mappings |
|
ServiceRequest.supportingInfo | |
Definition | Additional clinical information about the patient or specimen that may influence the services or their interpretations. This information includes diagnosis, clinical findings and other observations. In laboratory ordering these are typically referred to as "ask at order entry questions (AOEs)". This includes observations explicitly requested by the producer (filler) to provide context or supporting information needed to complete the order. For example, reporting the amount of inspired oxygen for blood gas measurements. |
Cardinality | 0...* |
Type | Reference(Resource) |
Alias | Ask at order entry question, AOE |
Comments | To represent information about how the services are to be delivered use the |
Invariants |
|
Mappings |
|
ServiceRequest.specimen | |
Definition | One or more specimens that the laboratory procedure will use. |
Cardinality | 0...* |
Type | Reference(Specimen) |
Summary | True |
Comments | Many diagnostic procedures need a specimen, but the request itself is not actually about the specimen. This element is for when the diagnostic is requested on already existing specimens and the request points to the specimen it applies to. Conversely, if the request is entered first with an unknown specimen, then the Specimen resource points to the ServiceRequest. |
Invariants |
|
Mappings |
|
ServiceRequest.bodySite | |
Definition | Anatomic location where the procedure should be performed. This is the target site. |
Cardinality | 0...* |
Type | CodeableConcept |
Binding | Codes describing anatomical locations. May include laterality. |
Summary | True |
Alias | location |
Requirements | Knowing where the procedure is performed is important for tracking if multiple sites are possible. |
Comments | Only used if not implicit in the code found in ServiceRequest.code. If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension procedure-targetBodyStructure. |
Invariants |
|
Mappings |
|
ServiceRequest.note | |
Definition | Any other notes and comments made about the service request. For example, internal billing notes. |
Cardinality | 0...* |
Type | Annotation |
Invariants |
|
Mappings |
|
ServiceRequest.patientInstruction | |
Definition | Instructions in terms that are understood by the patient or consumer. |
Cardinality | 0...1 |
Type | string |
Summary | True |
Invariants |
|
Mappings |
|
ServiceRequest.relevantHistory | |
Definition | Key events in the history of the request. |
Cardinality | 0...* |
Type | Reference(Provenance) |
Comments | This might not include provenances for all versions of the request – only those deemed “relevant” or important. This SHALL NOT include the Provenance associated with this current version of the resource. (If that provenance is deemed to be a “relevant” change, it will need to be added as part of a later update. Until then, it can be queried directly as the Provenance that points to this version using _revinclude All Provenances should have some historical version of this Request as their subject. |
Invariants |
|
Mappings |
|
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="svccore-servicerequest" /> <language value="Korean" /> <url value="http://phis.co.kr/fhir/StructureDefinition/StructureDefinition-svccore-servicerequest" /> <version value="0.0.1" /> <name value="SvcCore_ServiceRequest" /> <title value="Service Core ServiceRequest Profile" /> <status value="active" /> <date value="2023-10-30T01:53:15.6881432+00:00" /> <publisher value="PHIS" /> <description value="2023. 10. ServiceRequest의 대한 최소규격의 대하여 정의" /> <fhirVersion value="4.0.1" /> <kind value="resource" /> <abstract value="false" /> <type value="ServiceRequest" /> <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ServiceRequest" /> <derivation value="constraint" /> <differential> <element id="ServiceRequest"> <path value="ServiceRequest" /> <short value="수행될 서비스에 대한 요청" /> <definition value="진단 조사, 치료 또는 수술과 같은 서비스 요청의 기록입니다." /> </element> <element id="ServiceRequest.identifier"> <path value="ServiceRequest.identifier" /> <min value="1" /> </element> <element id="ServiceRequest.identifier.system"> <path value="ServiceRequest.identifier.system" /> <min value="1" /> </element> <element id="ServiceRequest.identifier.value"> <path value="ServiceRequest.identifier.value" /> <min value="1" /> </element> <element id="ServiceRequest.intent"> <path value="ServiceRequest.intent" /> <example> <label value="PHIS_DTx" /> <valueCode value="order" /> </example> </element> <element id="ServiceRequest.code"> <path value="ServiceRequest.code" /> <min value="1" /> </element> <element id="ServiceRequest.code.coding"> <path value="ServiceRequest.code.coding" /> <short value="EDI 코드체계 식별자 혹은 의료기관 식별자" /> <min value="1" /> <max value="1" /> </element> <element id="ServiceRequest.code.coding.system"> <path value="ServiceRequest.code.coding.system" /> <short value="EDI 코드체계 식별자 혹은 의료기관 식별자" /> <min value="1" /> </element> <element id="ServiceRequest.code.coding.code"> <path value="ServiceRequest.code.coding.code" /> <short value="EDI코드 혹은 DTx 플랫폼에 등록된 의료기관의 DTx 로컬 처방 코드" /> <min value="1" /> </element> <element id="ServiceRequest.subject"> <path value="ServiceRequest.subject" /> <type> <code value="Reference" /> <targetProfile value="http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-patient" /> </type> </element> <element id="ServiceRequest.encounter"> <path value="ServiceRequest.encounter" /> <min value="1" /> <type> <code value="Reference" /> <targetProfile value="http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-encounter" /> </type> </element> <element id="ServiceRequest.requester"> <path value="ServiceRequest.requester" /> <min value="1" /> <type> <code value="Reference" /> <targetProfile value="http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-medical-doctor-role" /> </type> </element> </differential> </StructureDefinition>
{ "resourceType": "StructureDefinition", "id": "svccore-servicerequest", "language": "Korean", "url": "http://phis.co.kr/fhir/StructureDefinition/StructureDefinition-svccore-servicerequest", "version": "0.0.1", "name": "SvcCore_ServiceRequest", "title": "Service Core ServiceRequest Profile", "status": "active", "date": "10/30/2023 01:53:15", "publisher": "PHIS", "description": "2023. 10. ServiceRequest의 대한 최소규격의 대하여 정의", "fhirVersion": "4.0.1", "kind": "resource", "abstract": false, "type": "ServiceRequest", "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ServiceRequest", "derivation": "constraint", "differential": { "element": [ { "id": "ServiceRequest", "path": "ServiceRequest", "short": "수행될 서비스에 대한 요청", "definition": "진단 조사, 치료 또는 수술과 같은 서비스 요청의 기록입니다." }, { "id": "ServiceRequest.identifier", "path": "ServiceRequest.identifier", "min": 1 }, { "id": "ServiceRequest.identifier.system", "path": "ServiceRequest.identifier.system", "min": 1 }, { "id": "ServiceRequest.identifier.value", "path": "ServiceRequest.identifier.value", "min": 1 }, { "id": "ServiceRequest.intent", "path": "ServiceRequest.intent", "example": [ { "label": "PHIS_DTx", "valueCode": "order" } ] }, { "id": "ServiceRequest.code", "path": "ServiceRequest.code", "min": 1 }, { "id": "ServiceRequest.code.coding", "path": "ServiceRequest.code.coding", "short": "EDI 코드체계 식별자 혹은 의료기관 식별자", "min": 1, "max": "1" }, { "id": "ServiceRequest.code.coding.system", "path": "ServiceRequest.code.coding.system", "short": "EDI 코드체계 식별자 혹은 의료기관 식별자", "min": 1 }, { "id": "ServiceRequest.code.coding.code", "path": "ServiceRequest.code.coding.code", "short": "EDI코드 혹은 DTx 플랫폼에 등록된 의료기관의 DTx 로컬 처방 코드", "min": 1 }, { "id": "ServiceRequest.subject", "path": "ServiceRequest.subject", "type": [ { "code": "Reference", "targetProfile": [ "http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-patient" ] } ] }, { "id": "ServiceRequest.encounter", "path": "ServiceRequest.encounter", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-encounter" ] } ] }, { "id": "ServiceRequest.requester", "path": "ServiceRequest.requester", "min": 1, "type": [ { "code": "Reference", "targetProfile": [ "http://www.hl7korea.or.kr/fhir/krcore/StructureDefinition/krcore-medical-doctor-role" ] } ] } ] } }