MyHealthWay
1.0.1 - Trial-Implementation
KR
MyHealthWay - Local Development build (v1.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://hins.or.kr/fhir/MyHealthWay/StructureDefinition/myhealthway-allergyintolerance | Version: 1.0.1 | |||
Active as of 2024-01-05 | Computable Name: MyHealthWayAllergyIntoleranceProfile |
MyHealthWay 의 알러지 및 부작용(불내성) 정보에 적용되는 AllergyIntolerance 구조.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from KRCore_AllergyIntolerance
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | 0..* | KRCore_AllergyIntolerance | KR Core AllergyIntolerance Profile | |
identifier | 1..1 | Identifier | 알레르기 및 불내성 식별자 | |
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
clinicalStatus | S | 0..1 | CodeableConcept | 알레르기 및 불내성 진행 상태: active | inactive | resolved |
coding | ||||
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
verificationStatus | S | 1..1 | CodeableConcept | 알레르기 및 불내성 검증 상태: unconfirmed | confirmed |
coding | S | 1..* | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
category | S | 0..* | code | 알레르기 및 불내성 원인 구분: food | medication | environment | biologic |
code | 1..1 | CodeableConcept | 알레르기 및 불내성 원인 코드 | |
coding:KD | S | 0..1 | Coding | Code defined by a terminology system Binding: KR Core Korea Drug Codes (required) |
system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode |
code | S | 1..1 | code | Symbol in syntax defined by the system |
patient | S | 1..1 | Reference(MyHealthWay Patient Profile) | 환자 정보 |
encounter | S | 1..1 | Reference(MyHealthWay Encounter Profile) | 내원 정보 |
onset[x] | 0..1 | dateTime | 알레르기 및 불내성 기록 일시 | |
recorder | 0..1 | Reference(MyHealthWay PractitionerRole Profile) | 기록 진료의 정보 | |
note | S | 0..* | Annotation | 추가 정보 |
text | S | 1..1 | markdown | The annotation - text content (as markdown) |
reaction | ||||
substance | 0..1 | CodeableConcept | 반응 물질 Binding: MyHealthWay AllergyIntolerance Substance Codes (example) | |
manifestation | 1..* | CodeableConcept | 알레르기 및 불내성 반응 증상 Binding: MyHealthWay AllergyIntolerance Manifestation Codes (example) | |
Documentation for this format |
Path | Conformance | ValueSet |
AllergyIntolerance.code.coding:KD | required | KR_Core_Korea_Drug_Codes |
AllergyIntolerance.reaction.substance | example | MyHealthWayAllergySubstanceCodes |
AllergyIntolerance.reaction.manifestation | example | MyHealthWayAllergyManifestationCodes |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | C | 0..* | KRCore_AllergyIntolerance | KR Core AllergyIntolerance Profile |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..1 | Identifier | 알레르기 및 불내성 식별자 |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | 알레르기 및 불내성 진행 상태: active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
verificationStatus | ?!SΣC | 1..1 | CodeableConcept | 알레르기 및 불내성 검증 상태: unconfirmed | confirmed Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
coding | SΣ | 1..* | Coding | Code defined by a terminology system |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
category | SΣ | 0..* | code | 알레르기 및 불내성 원인 구분: food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
code | SΣ | 1..1 | CodeableConcept | 알레르기 및 불내성 원인 코드 Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example) |
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this |
coding:ATC | SΣ | 0..1 | Coding | WHO ATC 코드 정보 Binding: ATC Codes (required) |
system | SΣ | 1..1 | uri | WHO ATC 코드체계 Fixed Value: http://www.whocc.no/atc |
code | SΣ | 1..1 | code | WHO ATC 코드 |
coding:KD | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: KR Core Korea Drug Codes (required) |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
patient | SΣ | 1..1 | Reference(MyHealthWay Patient Profile) | 환자 정보 |
encounter | S | 1..1 | Reference(MyHealthWay Encounter Profile) | 내원 정보 |
Slices for onset[x] | 0..1 | dateTime | 알레르기 및 불내성 기록 일시 Slice: Unordered, Closed by type:$this | |
onset[x]:onsetDateTime | 0..1 | dateTime | 알레르기 및 불내성 발생일 | |
recorder | 0..1 | Reference(MyHealthWay PractitionerRole Profile) | 기록 진료의 정보 | |
note | S | 0..* | Annotation | 추가 정보 |
text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
Documentation for this format |
Path | Conformance | ValueSet |
AllergyIntolerance.identifier.use | required | IdentifierUse |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes |
AllergyIntolerance.category | required | AllergyIntoleranceCategory |
AllergyIntolerance.code | example | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes |
AllergyIntolerance.code.coding:ATC | required | KR_Core_ATC_Codes |
AllergyIntolerance.code.coding:KD | required | KR_Core_Korea_Drug_Codes |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
krcore-alrg-01 | error | AllergyIntolerance | 알레르기 및 불내성 반응이 의약품에 의해 유발된 경우, 원인물질을 WHO ATC 코드로 식별. : (category = 'medication') implies code.coding.where(system ='http://www.whocc.no/atc').exists() | KR CDI 의무사항 |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
AllergyIntolerance | C | 0..* | KRCore_AllergyIntolerance | KR Core AllergyIntolerance Profile | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..1 | Identifier | 알레르기 및 불내성 식별자 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | 알레르기 및 불내성 진행 상태: active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
verificationStatus | ?!SΣC | 1..1 | CodeableConcept | 알레르기 및 불내성 검증 상태: unconfirmed | confirmed Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
category | SΣ | 0..* | code | 알레르기 및 불내성 원인 구분: food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
code | SΣ | 1..1 | CodeableConcept | 알레르기 및 불내성 원인 코드 Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
coding:ATC | SΣ | 0..1 | Coding | WHO ATC 코드 정보 Binding: ATC Codes (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | WHO ATC 코드체계 Fixed Value: http://www.whocc.no/atc | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | WHO ATC 코드 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:KD | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: KR Core Korea Drug Codes (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | 원인물질 (서술) | ||||
patient | SΣ | 1..1 | Reference(MyHealthWay Patient Profile) | 환자 정보 | ||||
encounter | S | 1..1 | Reference(MyHealthWay Encounter Profile) | 내원 정보 | ||||
Slices for onset[x] | 0..1 | dateTime | 알레르기 및 불내성 기록 일시 Slice: Unordered, Closed by type:$this | |||||
onset[x]:onsetDateTime | 0..1 | dateTime | 알레르기 및 불내성 발생일 | |||||
recordedDate | 0..1 | dateTime | Date first version of the resource instance was recorded | |||||
recorder | 0..1 | Reference(MyHealthWay PractitionerRole Profile) | 기록 진료의 정보 | |||||
asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy | ||||
lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||
note | S | 0..* | Annotation | 추가 정보 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
reaction | 0..* | BackboneElement | 알레르기 및 불내성 반응 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
substance | 0..1 | CodeableConcept | 반응 물질 Binding: MyHealthWay AllergyIntolerance Substance Codes (example) | |||||
manifestation | 1..* | CodeableConcept | 알레르기 및 불내성 반응 증상 Binding: MyHealthWay AllergyIntolerance Manifestation Codes (example) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | 알레르기 및 불내성 반응 증상 서술 | ||||
description | 0..1 | string | Description of the event as a whole | |||||
onset | 0..1 | dateTime | Date(/time) when manifestations showed | |||||
severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | |||||
exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||
note | 0..* | Annotation | Text about event not captured in other fields | |||||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
krcore-alrg-01 | error | AllergyIntolerance | 알레르기 및 불내성 반응이 의약품에 의해 유발된 경우, 원인물질을 WHO ATC 코드로 식별. : (category = 'medication') implies code.coding.where(system ='http://www.whocc.no/atc').exists() | KR CDI 의무사항 |
This structure is derived from KRCore_AllergyIntolerance
Summary
Mandatory: 8 elements (4 nested mandatory elements)
Must-Support: 15 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Differential View
This structure is derived from KRCore_AllergyIntolerance
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | 0..* | KRCore_AllergyIntolerance | KR Core AllergyIntolerance Profile | |
identifier | 1..1 | Identifier | 알레르기 및 불내성 식별자 | |
system | 1..1 | uri | The namespace for the identifier value | |
value | 1..1 | string | The value that is unique | |
clinicalStatus | S | 0..1 | CodeableConcept | 알레르기 및 불내성 진행 상태: active | inactive | resolved |
coding | ||||
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
verificationStatus | S | 1..1 | CodeableConcept | 알레르기 및 불내성 검증 상태: unconfirmed | confirmed |
coding | S | 1..* | Coding | Code defined by a terminology system |
system | S | 1..1 | uri | Identity of the terminology system |
code | S | 1..1 | code | Symbol in syntax defined by the system |
category | S | 0..* | code | 알레르기 및 불내성 원인 구분: food | medication | environment | biologic |
code | 1..1 | CodeableConcept | 알레르기 및 불내성 원인 코드 | |
coding:KD | S | 0..1 | Coding | Code defined by a terminology system Binding: KR Core Korea Drug Codes (required) |
system | S | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode |
code | S | 1..1 | code | Symbol in syntax defined by the system |
patient | S | 1..1 | Reference(MyHealthWay Patient Profile) | 환자 정보 |
encounter | S | 1..1 | Reference(MyHealthWay Encounter Profile) | 내원 정보 |
onset[x] | 0..1 | dateTime | 알레르기 및 불내성 기록 일시 | |
recorder | 0..1 | Reference(MyHealthWay PractitionerRole Profile) | 기록 진료의 정보 | |
note | S | 0..* | Annotation | 추가 정보 |
text | S | 1..1 | markdown | The annotation - text content (as markdown) |
reaction | ||||
substance | 0..1 | CodeableConcept | 반응 물질 Binding: MyHealthWay AllergyIntolerance Substance Codes (example) | |
manifestation | 1..* | CodeableConcept | 알레르기 및 불내성 반응 증상 Binding: MyHealthWay AllergyIntolerance Manifestation Codes (example) | |
Documentation for this format |
Path | Conformance | ValueSet |
AllergyIntolerance.code.coding:KD | required | KR_Core_Korea_Drug_Codes |
AllergyIntolerance.reaction.substance | example | MyHealthWayAllergySubstanceCodes |
AllergyIntolerance.reaction.manifestation | example | MyHealthWayAllergyManifestationCodes |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
AllergyIntolerance | C | 0..* | KRCore_AllergyIntolerance | KR Core AllergyIntolerance Profile |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | Σ | 1..1 | Identifier | 알레르기 및 불내성 식별자 |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | The value that is unique Example General: 123456 |
clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | 알레르기 및 불내성 진행 상태: active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. |
coding | Σ | 0..* | Coding | Code defined by a terminology system |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
verificationStatus | ?!SΣC | 1..1 | CodeableConcept | 알레르기 및 불내성 검증 상태: unconfirmed | confirmed Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. |
coding | SΣ | 1..* | Coding | Code defined by a terminology system |
system | SΣ | 1..1 | uri | Identity of the terminology system |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
category | SΣ | 0..* | code | 알레르기 및 불내성 원인 구분: food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. |
code | SΣ | 1..1 | CodeableConcept | 알레르기 및 불내성 원인 코드 Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example) |
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this |
coding:ATC | SΣ | 0..1 | Coding | WHO ATC 코드 정보 Binding: ATC Codes (required) |
system | SΣ | 1..1 | uri | WHO ATC 코드체계 Fixed Value: http://www.whocc.no/atc |
code | SΣ | 1..1 | code | WHO ATC 코드 |
coding:KD | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: KR Core Korea Drug Codes (required) |
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode |
code | SΣ | 1..1 | code | Symbol in syntax defined by the system |
patient | SΣ | 1..1 | Reference(MyHealthWay Patient Profile) | 환자 정보 |
encounter | S | 1..1 | Reference(MyHealthWay Encounter Profile) | 내원 정보 |
Slices for onset[x] | 0..1 | dateTime | 알레르기 및 불내성 기록 일시 Slice: Unordered, Closed by type:$this | |
onset[x]:onsetDateTime | 0..1 | dateTime | 알레르기 및 불내성 발생일 | |
recorder | 0..1 | Reference(MyHealthWay PractitionerRole Profile) | 기록 진료의 정보 | |
note | S | 0..* | Annotation | 추가 정보 |
text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) |
Documentation for this format |
Path | Conformance | ValueSet |
AllergyIntolerance.identifier.use | required | IdentifierUse |
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes |
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes |
AllergyIntolerance.category | required | AllergyIntoleranceCategory |
AllergyIntolerance.code | example | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes |
AllergyIntolerance.code.coding:ATC | required | KR_Core_ATC_Codes |
AllergyIntolerance.code.coding:KD | required | KR_Core_Korea_Drug_Codes |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
krcore-alrg-01 | error | AllergyIntolerance | 알레르기 및 불내성 반응이 의약품에 의해 유발된 경우, 원인물질을 WHO ATC 코드로 식별. : (category = 'medication') implies code.coding.where(system ='http://www.whocc.no/atc').exists() | KR CDI 의무사항 |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
AllergyIntolerance | C | 0..* | KRCore_AllergyIntolerance | KR Core AllergyIntolerance Profile | ||||
id | Σ | 0..1 | id | Logical id of this artifact | ||||
meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | Σ | 1..1 | Identifier | 알레르기 및 불내성 식별자 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | The value that is unique Example General: 123456 | ||||
period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
clinicalStatus | ?!SΣC | 0..1 | CodeableConcept | 알레르기 및 불내성 진행 상태: active | inactive | resolved Binding: AllergyIntoleranceClinicalStatusCodes (required): The clinical status of the allergy or intolerance. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
verificationStatus | ?!SΣC | 1..1 | CodeableConcept | 알레르기 및 불내성 검증 상태: unconfirmed | confirmed Binding: AllergyIntoleranceVerificationStatusCodes (required): Assertion about certainty associated with a propensity, or potential risk, of a reaction to the identified substance. | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | SΣ | 1..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
type | Σ | 0..1 | code | allergy | intolerance - Underlying mechanism (if known) Binding: AllergyIntoleranceType (required): Identification of the underlying physiological mechanism for a Reaction Risk. | ||||
category | SΣ | 0..* | code | 알레르기 및 불내성 원인 구분: food | medication | environment | biologic Binding: AllergyIntoleranceCategory (required): Category of an identified substance associated with allergies or intolerances. | ||||
criticality | Σ | 0..1 | code | low | high | unable-to-assess Binding: AllergyIntoleranceCriticality (required): Estimate of the potential clinical harm, or seriousness, of a reaction to an identified substance. | ||||
code | SΣ | 1..1 | CodeableConcept | 알레르기 및 불내성 원인 코드 Binding: AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes (example) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
Slices for coding | Σ | 0..* | Coding | Code defined by a terminology system Slice: Unordered, Open by value:$this | ||||
coding:ATC | SΣ | 0..1 | Coding | WHO ATC 코드 정보 Binding: ATC Codes (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | WHO ATC 코드체계 Fixed Value: http://www.whocc.no/atc | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | WHO ATC 코드 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
coding:KD | SΣ | 0..1 | Coding | Code defined by a terminology system Binding: KR Core Korea Drug Codes (required) | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | SΣ | 1..1 | uri | Identity of the terminology system Fixed Value: http://www.hl7korea.or.kr/CodeSystem/kpis-kdcode | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | 원인물질 (서술) | ||||
patient | SΣ | 1..1 | Reference(MyHealthWay Patient Profile) | 환자 정보 | ||||
encounter | S | 1..1 | Reference(MyHealthWay Encounter Profile) | 내원 정보 | ||||
Slices for onset[x] | 0..1 | dateTime | 알레르기 및 불내성 기록 일시 Slice: Unordered, Closed by type:$this | |||||
onset[x]:onsetDateTime | 0..1 | dateTime | 알레르기 및 불내성 발생일 | |||||
recordedDate | 0..1 | dateTime | Date first version of the resource instance was recorded | |||||
recorder | 0..1 | Reference(MyHealthWay PractitionerRole Profile) | 기록 진료의 정보 | |||||
asserter | Σ | 0..1 | Reference(Patient | RelatedPerson | Practitioner | PractitionerRole) | Source of the information about the allergy | ||||
lastOccurrence | 0..1 | dateTime | Date(/time) of last known occurrence of a reaction | |||||
note | S | 0..* | Annotation | 추가 정보 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
author[x] | Σ | 0..1 | Individual responsible for the annotation | |||||
authorReference | Reference(Practitioner | Patient | RelatedPerson | Organization) | |||||||
authorString | string | |||||||
time | Σ | 0..1 | dateTime | When the annotation was made | ||||
text | SΣ | 1..1 | markdown | The annotation - text content (as markdown) | ||||
reaction | 0..* | BackboneElement | 알레르기 및 불내성 반응 | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations | |||||
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
substance | 0..1 | CodeableConcept | 반응 물질 Binding: MyHealthWay AllergyIntolerance Substance Codes (example) | |||||
manifestation | 1..* | CodeableConcept | 알레르기 및 불내성 반응 증상 Binding: MyHealthWay AllergyIntolerance Manifestation Codes (example) | |||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
text | Σ | 0..1 | string | 알레르기 및 불내성 반응 증상 서술 | ||||
description | 0..1 | string | Description of the event as a whole | |||||
onset | 0..1 | dateTime | Date(/time) when manifestations showed | |||||
severity | 0..1 | code | mild | moderate | severe (of event as a whole) Binding: AllergyIntoleranceSeverity (required): Clinical assessment of the severity of a reaction event as a whole, potentially considering multiple different manifestations. | |||||
exposureRoute | 0..1 | CodeableConcept | How the subject was exposed to the substance Binding: SNOMEDCTRouteCodes (example): A coded concept describing the route or physiological path of administration of a therapeutic agent into or onto the body of a subject. | |||||
note | 0..* | Annotation | Text about event not captured in other fields | |||||
Documentation for this format |
Path | Conformance | ValueSet | ||||
AllergyIntolerance.language | preferred | CommonLanguages
| ||||
AllergyIntolerance.identifier.use | required | IdentifierUse | ||||
AllergyIntolerance.identifier.type | extensible | Identifier Type Codes | ||||
AllergyIntolerance.clinicalStatus | required | AllergyIntoleranceClinicalStatusCodes | ||||
AllergyIntolerance.verificationStatus | required | AllergyIntoleranceVerificationStatusCodes | ||||
AllergyIntolerance.type | required | AllergyIntoleranceType | ||||
AllergyIntolerance.category | required | AllergyIntoleranceCategory | ||||
AllergyIntolerance.criticality | required | AllergyIntoleranceCriticality | ||||
AllergyIntolerance.code | example | AllergyIntoleranceSubstance/Product,ConditionAndNegationCodes | ||||
AllergyIntolerance.code.coding:ATC | required | KR_Core_ATC_Codes | ||||
AllergyIntolerance.code.coding:KD | required | KR_Core_Korea_Drug_Codes | ||||
AllergyIntolerance.reaction.substance | example | MyHealthWayAllergySubstanceCodes | ||||
AllergyIntolerance.reaction.manifestation | example | MyHealthWayAllergyManifestationCodes | ||||
AllergyIntolerance.reaction.severity | required | AllergyIntoleranceSeverity | ||||
AllergyIntolerance.reaction.exposureRoute | example | SNOMEDCTRouteCodes |
Id | Grade | Path(s) | Details | Requirements |
ait-1 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL be present if verificationStatus is not entered-in-error. : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').exists() or clinicalStatus.exists() | |
ait-2 | error | AllergyIntolerance | AllergyIntolerance.clinicalStatus SHALL NOT be present if verification Status is entered-in-error : verificationStatus.coding.where(system = 'http://terminology.hl7.org/CodeSystem/allergyintolerance-verification' and code = 'entered-in-error').empty() or clinicalStatus.empty() | |
dom-2 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | AllergyIntolerance | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | AllergyIntolerance | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | AllergyIntolerance | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
krcore-alrg-01 | error | AllergyIntolerance | 알레르기 및 불내성 반응이 의약품에 의해 유발된 경우, 원인물질을 WHO ATC 코드로 식별. : (category = 'medication') implies code.coding.where(system ='http://www.whocc.no/atc').exists() | KR CDI 의무사항 |
This structure is derived from KRCore_AllergyIntolerance
Summary
Mandatory: 8 elements (4 nested mandatory elements)
Must-Support: 15 elements
Fixed Value: 1 element
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron