MyHealthWay
0.1.1 - draft
Korea, Republic of
MyHealthWay - Local Development build (v0.1.1). See the Directory of published versions
Official URL: https://hins.or.kr/fhir/MyHealthWay/StructureDefinition/myhealthway-documentreference | Version: 0.1.1 | |||
Draft as of 2023-12-21 | Computable Name: MyHealthWayDocumentReferenceProfile |
MyHealthWay 의 진료기록 정보에 적용되는 DocumentReference 구조.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from DocumentReference
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | A reference to a document | |
identifier | 1..1 | Identifier | 진료기록 정보 식별자 | |
system | 1..1 | uri | 식별체계 | |
value | 1..1 | string | 식별자 | |
status | 1..1 | code | 문서 상태 Fixed Value: current | |
type | S | 1..1 | CodeableConcept | 문서 타입 |
coding | S | 0..* | Coding | 정의된 코드 Binding: MyHealthWay Document Type Codes (example) |
system | S | 1..1 | uri | 코드체계 Fixed Value: http://loinc.org |
code | S | 1..1 | code | 코드값 |
text | S | 0..1 | string | 코드값 텍스트 |
subject | S | 1..1 | Reference(MyHealthWay Patient Profile) | 환자 정보 |
date | S | 1..1 | instant | 문서 생성 일시. {연}-{월}-{일}T{시}:{분}:{초} |
content | S | 1..* | BackboneElement | 문서 정보 |
attachment | S | 1..1 | Attachment | 문서 첨부 |
contentType | S | 0..1 | code | 첨부문서타입 |
data | S | 1..1 | base64Binary | 첨부문서 |
context | S | 0..1 | BackboneElement | 첨부문서 관련정보(내원정보) |
encounter | S | 0..* | Reference(MyHealthWay Encounter Profile) | 내원 정보 |
Documentation for this format |
Path | Conformance | ValueSet |
DocumentReference.type.coding | example | MyHealthWayDocTypeCodes |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | A reference to a document | |
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 | 식별체계 Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | 식별자 Example General: 123456 |
status | ?!Σ | 1..1 | code | 문서 상태 Binding: DocumentReferenceStatus (required): The status of the document reference. Fixed Value: current |
type | SΣ | 1..1 | CodeableConcept | 문서 타입 Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. |
coding | SΣ | 0..* | Coding | 정의된 코드 Binding: MyHealthWay Document Type Codes (example) |
system | SΣ | 1..1 | uri | 코드체계 Fixed Value: http://loinc.org |
code | SΣ | 1..1 | code | 코드값 |
text | SΣ | 0..1 | string | 코드값 텍스트 |
subject | SΣ | 1..1 | Reference(MyHealthWay Patient Profile) | 환자 정보 |
date | SΣ | 1..1 | instant | 문서 생성 일시. {연}-{월}-{일}T{시}:{분}:{초} |
content | SΣ | 1..* | BackboneElement | 문서 정보 |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attachment | SΣ | 1..1 | Attachment | 문서 첨부 |
contentType | SΣ | 0..1 | code | 첨부문서타입 Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png |
data | S | 1..1 | base64Binary | 첨부문서 |
context | SΣ | 0..1 | BackboneElement | 첨부문서 관련정보(내원정보) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
encounter | S | 0..* | Reference(MyHealthWay Encounter Profile) | 내원 정보 |
Documentation for this format |
Path | Conformance | ValueSet / Code |
DocumentReference.identifier.use | required | IdentifierUse |
DocumentReference.status | required | Fixed Value: current |
DocumentReference.type | preferred | DocumentTypeValueSet |
DocumentReference.type.coding | example | MyHealthWayDocTypeCodes |
DocumentReference.content.attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13 ) |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | 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 | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | 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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | A reference to a document | |||||
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 | ||||
masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
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 | 식별체계 Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | 식별자 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) | ||||
status | ?!Σ | 1..1 | code | 문서 상태 Binding: DocumentReferenceStatus (required): The status of the document reference. Fixed Value: current | ||||
docStatus | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
type | SΣ | 1..1 | CodeableConcept | 문서 타입 Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. | ||||
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Σ | 0..* | Coding | 정의된 코드 Binding: MyHealthWay Document Type 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 | |||||
system | SΣ | 1..1 | uri | 코드체계 Fixed Value: http://loinc.org | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | 코드값 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | SΣ | 0..1 | string | 코드값 텍스트 | ||||
category | Σ | 0..* | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
subject | SΣ | 1..1 | Reference(MyHealthWay Patient Profile) | 환자 정보 | ||||
date | SΣ | 1..1 | instant | 문서 생성 일시. {연}-{월}-{일}T{시}:{분}:{초} | ||||
author | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | ||||
authenticator | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
custodian | 0..1 | Reference(Organization) | Organization which maintains the document | |||||
relatesTo | Σ | 0..* | BackboneElement | Relationships to other documents | ||||
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 | ||||
code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
description | Σ | 0..1 | string | Human-readable description | ||||
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
content | SΣ | 1..* | 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 | ||||
attachment | SΣ | 1..1 | Attachment | 문서 첨부 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
contentType | SΣ | 0..1 | code | 첨부문서타입 Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
data | S | 1..1 | base64Binary | 첨부문서 | ||||
url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
format | Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
context | SΣ | 0..1 | 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 | ||||
encounter | S | 0..* | Reference(MyHealthWay Encounter Profile) | 내원 정보 | ||||
event | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
period | Σ | 0..1 | Period | Time of service that is being documented | ||||
facilityType | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
practiceSetting | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
sourcePatientInfo | 0..1 | Reference(Patient) | Patient demographics from source | |||||
related | 0..* | Reference(Resource) | Related identifiers or resources | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
DocumentReference.language | preferred | CommonLanguages
| ||||
DocumentReference.identifier.use | required | IdentifierUse | ||||
DocumentReference.identifier.type | extensible | Identifier Type Codes | ||||
DocumentReference.status | required | Fixed Value: current | ||||
DocumentReference.docStatus | required | CompositionStatus | ||||
DocumentReference.type | preferred | DocumentTypeValueSet | ||||
DocumentReference.type.coding | example | MyHealthWayDocTypeCodes | ||||
DocumentReference.category | example | DocumentClassValueSet | ||||
DocumentReference.relatesTo.code | required | DocumentRelationshipType | ||||
DocumentReference.securityLabel | extensible | All Security Labels | ||||
DocumentReference.content.attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13 ) | ||||
DocumentReference.content.attachment.language | preferred | CommonLanguages
| ||||
DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem ) | ||||
DocumentReference.context.event | example | ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSet | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSet |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | 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 | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | 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() |
This structure is derived from DocumentReference
Differential View
This structure is derived from DocumentReference
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | A reference to a document | |
identifier | 1..1 | Identifier | 진료기록 정보 식별자 | |
system | 1..1 | uri | 식별체계 | |
value | 1..1 | string | 식별자 | |
status | 1..1 | code | 문서 상태 Fixed Value: current | |
type | S | 1..1 | CodeableConcept | 문서 타입 |
coding | S | 0..* | Coding | 정의된 코드 Binding: MyHealthWay Document Type Codes (example) |
system | S | 1..1 | uri | 코드체계 Fixed Value: http://loinc.org |
code | S | 1..1 | code | 코드값 |
text | S | 0..1 | string | 코드값 텍스트 |
subject | S | 1..1 | Reference(MyHealthWay Patient Profile) | 환자 정보 |
date | S | 1..1 | instant | 문서 생성 일시. {연}-{월}-{일}T{시}:{분}:{초} |
content | S | 1..* | BackboneElement | 문서 정보 |
attachment | S | 1..1 | Attachment | 문서 첨부 |
contentType | S | 0..1 | code | 첨부문서타입 |
data | S | 1..1 | base64Binary | 첨부문서 |
context | S | 0..1 | BackboneElement | 첨부문서 관련정보(내원정보) |
encounter | S | 0..* | Reference(MyHealthWay Encounter Profile) | 내원 정보 |
Documentation for this format |
Path | Conformance | ValueSet |
DocumentReference.type.coding | example | MyHealthWayDocTypeCodes |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | A reference to a document | |
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 | 식별체계 Example General: http://www.acme.com/identifiers/patient |
value | Σ | 1..1 | string | 식별자 Example General: 123456 |
status | ?!Σ | 1..1 | code | 문서 상태 Binding: DocumentReferenceStatus (required): The status of the document reference. Fixed Value: current |
type | SΣ | 1..1 | CodeableConcept | 문서 타입 Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. |
coding | SΣ | 0..* | Coding | 정의된 코드 Binding: MyHealthWay Document Type Codes (example) |
system | SΣ | 1..1 | uri | 코드체계 Fixed Value: http://loinc.org |
code | SΣ | 1..1 | code | 코드값 |
text | SΣ | 0..1 | string | 코드값 텍스트 |
subject | SΣ | 1..1 | Reference(MyHealthWay Patient Profile) | 환자 정보 |
date | SΣ | 1..1 | instant | 문서 생성 일시. {연}-{월}-{일}T{시}:{분}:{초} |
content | SΣ | 1..* | BackboneElement | 문서 정보 |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
attachment | SΣ | 1..1 | Attachment | 문서 첨부 |
contentType | SΣ | 0..1 | code | 첨부문서타입 Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png |
data | S | 1..1 | base64Binary | 첨부문서 |
context | SΣ | 0..1 | BackboneElement | 첨부문서 관련정보(내원정보) |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
encounter | S | 0..* | Reference(MyHealthWay Encounter Profile) | 내원 정보 |
Documentation for this format |
Path | Conformance | ValueSet / Code |
DocumentReference.identifier.use | required | IdentifierUse |
DocumentReference.status | required | Fixed Value: current |
DocumentReference.type | preferred | DocumentTypeValueSet |
DocumentReference.type.coding | example | MyHealthWayDocTypeCodes |
DocumentReference.content.attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13 ) |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | 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 | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | 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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
DocumentReference | 0..* | DocumentReference | A reference to a document | |||||
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 | ||||
masterIdentifier | Σ | 0..1 | Identifier | Master Version Specific Identifier | ||||
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 | 식별체계 Example General: http://www.acme.com/identifiers/patient | ||||
value | Σ | 1..1 | string | 식별자 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) | ||||
status | ?!Σ | 1..1 | code | 문서 상태 Binding: DocumentReferenceStatus (required): The status of the document reference. Fixed Value: current | ||||
docStatus | Σ | 0..1 | code | preliminary | final | amended | entered-in-error Binding: CompositionStatus (required): Status of the underlying document. | ||||
type | SΣ | 1..1 | CodeableConcept | 문서 타입 Binding: DocumentTypeValueSet (preferred): Precise type of clinical document. | ||||
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Σ | 0..* | Coding | 정의된 코드 Binding: MyHealthWay Document Type 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 | |||||
system | SΣ | 1..1 | uri | 코드체계 Fixed Value: http://loinc.org | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | SΣ | 1..1 | code | 코드값 | ||||
display | Σ | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | SΣ | 0..1 | string | 코드값 텍스트 | ||||
category | Σ | 0..* | CodeableConcept | Categorization of document Binding: DocumentClassValueSet (example): High-level kind of a clinical document at a macro level. | ||||
subject | SΣ | 1..1 | Reference(MyHealthWay Patient Profile) | 환자 정보 | ||||
date | SΣ | 1..1 | instant | 문서 생성 일시. {연}-{월}-{일}T{시}:{분}:{초} | ||||
author | Σ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the document | ||||
authenticator | 0..1 | Reference(Practitioner | PractitionerRole | Organization) | Who/what authenticated the document | |||||
custodian | 0..1 | Reference(Organization) | Organization which maintains the document | |||||
relatesTo | Σ | 0..* | BackboneElement | Relationships to other documents | ||||
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 | ||||
code | Σ | 1..1 | code | replaces | transforms | signs | appends Binding: DocumentRelationshipType (required): The type of relationship between documents. | ||||
target | Σ | 1..1 | Reference(DocumentReference) | Target of the relationship | ||||
description | Σ | 0..1 | string | Human-readable description | ||||
securityLabel | Σ | 0..* | CodeableConcept | Document security-tags Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
content | SΣ | 1..* | 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 | ||||
attachment | SΣ | 1..1 | Attachment | 문서 첨부 | ||||
id | 0..1 | string | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
contentType | SΣ | 0..1 | code | 첨부문서타입 Binding: Mime Types (required): The mime type of an attachment. Any valid mime type is allowed. Example General: text/plain; charset=UTF-8, image/png | ||||
language | Σ | 0..1 | code | Human language of the content (BCP-47) Binding: CommonLanguages (preferred): A human language.
Example General: en-AU | ||||
data | S | 1..1 | base64Binary | 첨부문서 | ||||
url | Σ | 0..1 | url | Uri where the data can be found Example General: http://www.acme.com/logo-small.png | ||||
size | Σ | 0..1 | unsignedInt | Number of bytes of content (if url provided) | ||||
hash | Σ | 0..1 | base64Binary | Hash of the data (sha-1, base64ed) | ||||
title | Σ | 0..1 | string | Label to display in place of the data Example General: Official Corporate Logo | ||||
creation | Σ | 0..1 | dateTime | Date attachment was first created | ||||
format | Σ | 0..1 | Coding | Format/content rules for the document Binding: DocumentReferenceFormatCodeSet (preferred): Document Format Codes. | ||||
context | SΣ | 0..1 | 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 | ||||
encounter | S | 0..* | Reference(MyHealthWay Encounter Profile) | 내원 정보 | ||||
event | 0..* | CodeableConcept | Main clinical acts documented Binding: v3 Code System ActCode (example): This list of codes represents the main clinical acts being documented. | |||||
period | Σ | 0..1 | Period | Time of service that is being documented | ||||
facilityType | 0..1 | CodeableConcept | Kind of facility where patient was seen Binding: FacilityTypeCodeValueSet (example): XDS Facility Type. | |||||
practiceSetting | 0..1 | CodeableConcept | Additional details about where the content was created (e.g. clinical specialty) Binding: PracticeSettingCodeValueSet (example): Additional details about where the content was created (e.g. clinical specialty). | |||||
sourcePatientInfo | 0..1 | Reference(Patient) | Patient demographics from source | |||||
related | 0..* | Reference(Resource) | Related identifiers or resources | |||||
Documentation for this format |
Path | Conformance | ValueSet / Code | ||||
DocumentReference.language | preferred | CommonLanguages
| ||||
DocumentReference.identifier.use | required | IdentifierUse | ||||
DocumentReference.identifier.type | extensible | Identifier Type Codes | ||||
DocumentReference.status | required | Fixed Value: current | ||||
DocumentReference.docStatus | required | CompositionStatus | ||||
DocumentReference.type | preferred | DocumentTypeValueSet | ||||
DocumentReference.type.coding | example | MyHealthWayDocTypeCodes | ||||
DocumentReference.category | example | DocumentClassValueSet | ||||
DocumentReference.relatesTo.code | required | DocumentRelationshipType | ||||
DocumentReference.securityLabel | extensible | All Security Labels | ||||
DocumentReference.content.attachment.contentType | required | Mime Types (a valid code from urn:ietf:bcp:13 ) | ||||
DocumentReference.content.attachment.language | preferred | CommonLanguages
| ||||
DocumentReference.content.format | preferred | DocumentReferenceFormatCodeSet (a valid code from http://ihe.net/fhir/ValueSet/IHE.FormatCode.codesystem ) | ||||
DocumentReference.context.event | example | ActCode | ||||
DocumentReference.context.facilityType | example | FacilityTypeCodeValueSet | ||||
DocumentReference.context.practiceSetting | example | PracticeSettingCodeValueSet |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | DocumentReference | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | DocumentReference | 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 | DocumentReference | 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 | DocumentReference | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | DocumentReference | 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() |
This structure is derived from DocumentReference
Other representations of profile: CSV, Excel, Schematron