旅遊醫學疫苗接種或開立藥品紀錄上傳實作指引
1.0.0 - ci-build
旅遊醫學疫苗接種或開立藥品紀錄上傳實作指引
1.0.0 - ci-build
This page is part of the 旅遊醫學疫苗接種或開立藥品紀錄上傳實作指引 (v1.0.0: Releases Ballot 1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions
| Official URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/medicationAdministration-vacc | Version: 1.0.0 | |||
| Active as of 2024-09-23 | Computable Name: MedicationAdministrationVACC | |||
此開立藥品紀錄（MedicationAdministration VACC）Profile 說明本IG如何進一步定義 FHIR的 MedicationAdministration Resource 以呈現接種疫苗/開立藥品紀錄之開立藥品紀錄。
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from MedicationAdministration
| Id | Grade | Path(s) | Details | Requirements |
| code-med-stockType | error | MedicationAdministration | 當StockType = 0(庫存)，則fundingSource(收費類型)必填 : (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '0').exists()) implies (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.exists()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  MedicationAdministration |
C | 0..* | MedicationAdministration | Administration of medication to a patient code-med-stockType: 當StockType = 0(庫存)，則fundingSource(收費類型)必填 |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
  Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
   StockType |
S | 1..1 | CodeableConcept | 庫存類別 URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type Binding: CDC-VACC系統-庫存類別值集 (required) |
 FundingSource |
S | 0..1 | CodeableConcept | 收費類型 URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-funding-source Binding: ImmunizationFundingSource (required) |
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
 identifier |
S | 1..* | Identifier | External identifier |
| status |
?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. |
 Slices for medication[x] |
Σ | 1..1 | What was administered Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |
| medicationCodeableConcept |
CodeableConcept | |||
 medicationReference |
Reference(Medication) | |||
| medication[x]:medicationReference |
Σ | 0..1 | Reference(藥品資料（Medication VACC）) | What was administered |
| subject |
Σ | 1..1 | Reference(個案資料（Patient VACC）) | Who received medication |
| supportingInformation |
S | 1..1 | Reference(接種機構（Vaccination Organization VACC/NIIS）) | 開立藥品的醫事機構 |
| Slices for effective[x] |
Σ | 1..1 | dateTime | Start and end time of administration Slice: Unordered, Closed by type:$this |
| effective[x]:effectiveDateTime |
SΣ | 1..1 | dateTime | Start and end time of administration |
| reasonReference |
0..* | Reference(個案出境資料（Observation VACC）) | Condition or observation that supports why the medication was administered | |
| note |
S | 0..* | Annotation | TravelDataKey |
 dosage |
C | 0..1 | BackboneElement | Details of how medication was taken mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| dose |
0..1 | SimpleQuantity | Amount of medication per dose | |
 value |
SΣ | 1..1 | decimal | 藥品數量 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1from the FHIR Standard | |
| MedicationAdministration.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| code-med-stockType | error | MedicationAdministration | 當StockType = 0(庫存)，則fundingSource(收費類型)必填 : (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '0').exists()) implies (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.exists()) | |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | 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 | MedicationAdministration | 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 | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | 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() | |
| mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationAdministration |
C | 0..* | MedicationAdministration | Administration of medication to a patient code-med-stockType: 當StockType = 0(庫存)，則fundingSource(收費類型)必填 | ||||
| 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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| StockType |
S | 1..1 | CodeableConcept | 庫存類別 URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type Binding: CDC-VACC系統-庫存類別值集 (required) | ||||
| FundingSource |
S | 0..1 | CodeableConcept | 收費類型 URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-funding-source Binding: ImmunizationFundingSource (required) | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
S | 1..* | Identifier | External identifier | ||||
| instantiates |
Σ | 0..* | uri | Instantiates protocol or definition | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event | ||||
| status |
?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. | ||||
| statusReason |
0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |||||
| category |
0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur. | |||||
| Slices for medication[x] |
Σ | 1..1 | What was administered Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(Medication) | |||||||
| medication[x]:medicationReference |
Σ | 0..1 | Reference(藥品資料（Medication VACC）) | What was administered | ||||
| subject |
Σ | 1..1 | Reference(個案資料（Patient VACC）) | Who received medication | ||||
| context |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | |||||
| supportingInformation |
S | 1..1 | Reference(接種機構（Vaccination Organization VACC/NIIS）) | 開立藥品的醫事機構 | ||||
| Slices for effective[x] |
Σ | 1..1 | dateTime | Start and end time of administration Slice: Unordered, Closed by type:$this | ||||
| effective[x]:effectiveDateTime |
SΣ | 1..1 | dateTime | Start and end time of administration | ||||
| performer |
Σ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
| 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 | ||||
| function |
0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication. | |||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration | ||||
| reasonCode |
0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. | |||||
| reasonReference |
0..* | Reference(個案出境資料（Observation VACC）) | Condition or observation that supports why the medication was administered | |||||
| request |
0..1 | Reference(MedicationRequest) | Request administration performed against | |||||
| device |
0..* | Reference(Device) | Device used to administer | |||||
| note |
S | 0..* | Annotation | TravelDataKey | ||||
| dosage |
C | 0..1 | BackboneElement | Details of how medication was taken mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] | ||||
| 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 | ||||
| text |
0..1 | string | Free text dosage instructions e.g. SIG | |||||
| site |
0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | |||||
| route |
0..1 | CodeableConcept | Path of substance into body 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. | |||||
| method |
0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |||||
| dose |
0..1 | SimpleQuantity | Amount of medication per dose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
SΣ | 1..1 | decimal | 藥品數量 | ||||
| unit |
Σ | 0..1 | string | Unit representation | ||||
| system |
ΣC | 0..1 | uri | System that defines coded unit form | ||||
| code |
Σ | 0..1 | code | Coded form of the unit | ||||
 rate[x] |
0..1 | Dose quantity per unit of time | ||||||
| rateRatio |
Ratio | |||||||
| rateQuantity |
Quantity(SimpleQuantity) | |||||||
| eventHistory |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| MedicationAdministration.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1from the FHIR Standard | ||||
| MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codesfrom the FHIR Standard | ||||
| MedicationAdministration.category | preferred | MedicationAdministration Category Codeshttp://hl7.org/fhir/ValueSet/medication-admin-categoryfrom the FHIR Standard | ||||
| MedicationAdministration.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| MedicationAdministration.performer.function | example | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-functionfrom the FHIR Standard | ||||
| MedicationAdministration.reasonCode | example | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codesfrom the FHIR Standard | ||||
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codesfrom the FHIR Standard | ||||
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesfrom the FHIR Standard | ||||
| MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| code-med-stockType | error | MedicationAdministration | 當StockType = 0(庫存)，則fundingSource(收費類型)必填 : (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '0').exists()) implies (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.exists()) | |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | 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 | MedicationAdministration | 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 | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | 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() | |
| mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() |
This structure is derived from MedicationAdministration
Summary
Mandatory: 5 elements(1 nested mandatory element)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from MedicationAdministration
| Id | Grade | Path(s) | Details | Requirements |
| code-med-stockType | error | MedicationAdministration | 當StockType = 0(庫存)，則fundingSource(收費類型)必填 : (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '0').exists()) implies (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.exists()) |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| MedicationAdministration |
C | 0..* | MedicationAdministration | Administration of medication to a patient code-med-stockType: 當StockType = 0(庫存)，則fundingSource(收費類型)必填 |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |
| StockType |
S | 1..1 | CodeableConcept | 庫存類別 URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type Binding: CDC-VACC系統-庫存類別值集 (required) |
| FundingSource |
S | 0..1 | CodeableConcept | 收費類型 URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-funding-source Binding: ImmunizationFundingSource (required) |
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier |
S | 1..* | Identifier | External identifier |
| status |
?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. |
| Slices for medication[x] |
Σ | 1..1 | What was administered Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |
| medicationCodeableConcept |
CodeableConcept | |||
| medicationReference |
Reference(Medication) | |||
| medication[x]:medicationReference |
Σ | 0..1 | Reference(藥品資料（Medication VACC）) | What was administered |
| subject |
Σ | 1..1 | Reference(個案資料（Patient VACC）) | Who received medication |
| supportingInformation |
S | 1..1 | Reference(接種機構（Vaccination Organization VACC/NIIS）) | 開立藥品的醫事機構 |
| Slices for effective[x] |
Σ | 1..1 | dateTime | Start and end time of administration Slice: Unordered, Closed by type:$this |
| effective[x]:effectiveDateTime |
SΣ | 1..1 | dateTime | Start and end time of administration |
| reasonReference |
0..* | Reference(個案出境資料（Observation VACC）) | Condition or observation that supports why the medication was administered | |
| note |
S | 0..* | Annotation | TravelDataKey |
| dosage |
C | 0..1 | BackboneElement | Details of how medication was taken mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| dose |
0..1 | SimpleQuantity | Amount of medication per dose | |
| value |
SΣ | 1..1 | decimal | 藥品數量 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1from the FHIR Standard | |
| MedicationAdministration.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| code-med-stockType | error | MedicationAdministration | 當StockType = 0(庫存)，則fundingSource(收費類型)必填 : (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '0').exists()) implies (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.exists()) | |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | 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 | MedicationAdministration | 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 | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | 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() | |
| mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| MedicationAdministration |
C | 0..* | MedicationAdministration | Administration of medication to a patient code-med-stockType: 當StockType = 0(庫存)，則fundingSource(收費類型)必填 | ||||
| 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 | |||||
| Slices for extension |
1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| StockType |
S | 1..1 | CodeableConcept | 庫存類別 URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type Binding: CDC-VACC系統-庫存類別值集 (required) | ||||
| FundingSource |
S | 0..1 | CodeableConcept | 收費類型 URL: https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-funding-source Binding: ImmunizationFundingSource (required) | ||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
S | 1..* | Identifier | External identifier | ||||
| instantiates |
Σ | 0..* | uri | Instantiates protocol or definition | ||||
| partOf |
Σ | 0..* | Reference(MedicationAdministration | Procedure) | Part of referenced event | ||||
| status |
?!Σ | 1..1 | code | in-progress | not-done | on-hold | completed | entered-in-error | stopped | unknown Binding: MedicationAdministration Status Codes (required): A set of codes indicating the current status of a MedicationAdministration. | ||||
| statusReason |
0..* | CodeableConcept | Reason administration not performed Binding: SNOMEDCTReasonMedicationNotGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration is negated. | |||||
| category |
0..1 | CodeableConcept | Type of medication usage Binding: MedicationAdministration Category Codes (preferred): A coded concept describing where the medication administered is expected to occur. | |||||
| Slices for medication[x] |
Σ | 1..1 | What was administered Slice: Unordered, Open by type:$this Binding: SNOMEDCTMedicationCodes (example): Codes identifying substance or product that can be administered. | |||||
| medicationCodeableConcept |
CodeableConcept | |||||||
| medicationReference |
Reference(Medication) | |||||||
| medication[x]:medicationReference |
Σ | 0..1 | Reference(藥品資料（Medication VACC）) | What was administered | ||||
| subject |
Σ | 1..1 | Reference(個案資料（Patient VACC）) | Who received medication | ||||
| context |
0..1 | Reference(Encounter | EpisodeOfCare) | Encounter or Episode of Care administered as part of | |||||
| supportingInformation |
S | 1..1 | Reference(接種機構（Vaccination Organization VACC/NIIS）) | 開立藥品的醫事機構 | ||||
| Slices for effective[x] |
Σ | 1..1 | dateTime | Start and end time of administration Slice: Unordered, Closed by type:$this | ||||
| effective[x]:effectiveDateTime |
SΣ | 1..1 | dateTime | Start and end time of administration | ||||
| performer |
Σ | 0..* | BackboneElement | Who performed the medication administration and what they did | ||||
| 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 | ||||
| function |
0..1 | CodeableConcept | Type of performance Binding: MedicationAdministration Performer Function Codes (example): A code describing the role an individual played in administering the medication. | |||||
| actor |
Σ | 1..1 | Reference(Practitioner | PractitionerRole | Patient | RelatedPerson | Device) | Who performed the medication administration | ||||
| reasonCode |
0..* | CodeableConcept | Reason administration performed Binding: ReasonMedicationGivenCodes (example): A set of codes indicating the reason why the MedicationAdministration was made. | |||||
| reasonReference |
0..* | Reference(個案出境資料（Observation VACC）) | Condition or observation that supports why the medication was administered | |||||
| request |
0..1 | Reference(MedicationRequest) | Request administration performed against | |||||
| device |
0..* | Reference(Device) | Device used to administer | |||||
| note |
S | 0..* | Annotation | TravelDataKey | ||||
| dosage |
C | 0..1 | BackboneElement | Details of how medication was taken mad-1: SHALL have at least one of dosage.dose or dosage.rate[x] | ||||
| 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 | ||||
| text |
0..1 | string | Free text dosage instructions e.g. SIG | |||||
| site |
0..1 | CodeableConcept | Body site administered to Binding: SNOMEDCTAnatomicalStructureForAdministrationSiteCodes (example): A coded concept describing the site location the medicine enters into or onto the body. | |||||
| route |
0..1 | CodeableConcept | Path of substance into body 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. | |||||
| method |
0..1 | CodeableConcept | How drug was administered Binding: SNOMEDCTAdministrationMethodCodes (example): A coded concept describing the technique by which the medicine is administered. | |||||
| dose |
0..1 | SimpleQuantity | Amount of medication per dose | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| value |
SΣ | 1..1 | decimal | 藥品數量 | ||||
| unit |
Σ | 0..1 | string | Unit representation | ||||
| system |
ΣC | 0..1 | uri | System that defines coded unit form | ||||
| code |
Σ | 0..1 | code | Coded form of the unit | ||||
| rate[x] |
0..1 | Dose quantity per unit of time | ||||||
| rateRatio |
Ratio | |||||||
| rateQuantity |
Quantity(SimpleQuantity) | |||||||
| eventHistory |
0..* | Reference(Provenance) | A list of events of interest in the lifecycle | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||
| MedicationAdministration.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| MedicationAdministration.status | required | MedicationAdministration Status Codeshttp://hl7.org/fhir/ValueSet/medication-admin-status|4.0.1from the FHIR Standard | ||||
| MedicationAdministration.statusReason | example | SNOMEDCTReasonMedicationNotGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-not-given-codesfrom the FHIR Standard | ||||
| MedicationAdministration.category | preferred | MedicationAdministration Category Codeshttp://hl7.org/fhir/ValueSet/medication-admin-categoryfrom the FHIR Standard | ||||
| MedicationAdministration.medication[x] | example | SNOMEDCTMedicationCodeshttp://hl7.org/fhir/ValueSet/medication-codesfrom the FHIR Standard | ||||
| MedicationAdministration.performer.function | example | MedicationAdministration Performer Function Codeshttp://hl7.org/fhir/ValueSet/med-admin-perform-functionfrom the FHIR Standard | ||||
| MedicationAdministration.reasonCode | example | ReasonMedicationGivenCodeshttp://hl7.org/fhir/ValueSet/reason-medication-given-codesfrom the FHIR Standard | ||||
| MedicationAdministration.dosage.site | example | SNOMEDCTAnatomicalStructureForAdministrationSiteCodeshttp://hl7.org/fhir/ValueSet/approach-site-codesfrom the FHIR Standard | ||||
| MedicationAdministration.dosage.route | example | SNOMEDCTRouteCodeshttp://hl7.org/fhir/ValueSet/route-codesfrom the FHIR Standard | ||||
| MedicationAdministration.dosage.method | example | SNOMEDCTAdministrationMethodCodeshttp://hl7.org/fhir/ValueSet/administration-method-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| code-med-stockType | error | MedicationAdministration | 當StockType = 0(庫存)，則fundingSource(收費類型)必填 : (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.where(code = '0').exists()) implies (extension.where(url = 'https://vacc.cdc.gov.tw/vacc/StructureDefinition/vacc-stock-type').value.ofType(CodeableConcept).coding.exists()) | |
| dom-2 | error | MedicationAdministration | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | MedicationAdministration | 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 | MedicationAdministration | 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 | MedicationAdministration | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | MedicationAdministration | 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() | |
| mad-1 | error | MedicationAdministration.dosage | SHALL have at least one of dosage.dose or dosage.rate[x] : dose.exists() or rate.exists() |
This structure is derived from MedicationAdministration
Summary
Mandatory: 5 elements(1 nested mandatory element)
Must-Support: 7 elements
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron
以下概述了此Profile所需的RESTful FHIR互動功能。有關VACC支援的RESTful互動功能的完整清單，請參閱VACC Server能力聲明。
必須（SHALL） 支援透過查詢參數 patient 查詢所有MedicationAdministration：
(如何透過reference查詢)
GET [base]/MedicationAdministration?Patient/[id]
GET [base]/MedicationAdministration?patient.identifier=[code]&patient.birthdate=[date]
例子：
(1) GET [base]/MedicationAdministration?Patient/medicationAdministration-min
(2) GET [base]/MedicationAdministration?patient.identifier=888800371&patient.birthdate=1983-02-15
