International Patient Summary 1.0.0 Release - Local Development build (v1.0). See the Directory of published versions
Official URL: http://localhost:8877/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.4--20210902121754 | Version: 1.0 | |||
Draft as of 2021-09-02 | Computable Name: IPSMedicationStatement | |||
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.22.4.4 (use: OFFICIAL) |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from CDAR2.SubstanceAdministration
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | S | 0..* | CDAR2.SubstanceAdministration | Base for all types and resources |
![]() ![]() ![]() | 0..1 | code | ||
![]() ![]() ![]() | S | 1..1 | ||
![]() ![]() ![]() | S | 0..1 | ||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | S | 1..1 | ||
![]() ![]() ![]() ![]() | 1..1 | code | Binding: Medication Time Units (UCUM.html) (required): Medication Time Units (UCUM.html) | |
![]() ![]() ![]() | 1..1 | code | Fixed Value: SBADM | |
![]() ![]() ![]() | 1..1 | code | Binding: MoodCodeEvnInt (required): MoodCodeEvnInt | |
![]() ![]() ![]() | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() | S | 1..1 | II | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.4 | |
![]() ![]() ![]() | S | 0..* | II | |
![]() ![]() ![]() | S | 1..1 | CD | Binding: Absent or Unknown Medication (required): Absent or Unknown Medication |
![]() ![]() ![]() | S | 0..1 | ED | |
![]() ![]() ![]() ![]() | S | 1..1 | TEL | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | ||
![]() ![]() ![]() | S | 1..1 | CS | Binding: ActStatusActiveCompletedAbortedSuspended (required): ActStatusActiveCompletedAbortedSuspended |
![]() ![]() ![]() | S | 0..1 | CE | Binding: Medicine Route of Administration (required): Medicine Route of Administration |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | S | 1..1 | Element | |
![]() ![]() ![]() ![]() | 1..1 | code | Fixed Value: CSM | |
![]() ![]() ![]() | 0..* | Author | ||
![]() ![]() ![]() | 0..* | Element | Slice: Unordered, Open by value:profile | |
![]() ![]() ![]() ![]() | C | 0..* | UVSubordinateadministration | Base for all types and resources entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2017-04-30.html) |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Fixed Value: COMP | |
![]() |
Path | Conformance | ValueSet |
SubstanceAdministration.width.unit | required | MedicationTimeUnits |
SubstanceAdministration.moodCode | required | MoodCodeEvnInt |
SubstanceAdministration.code | required | IPSNoMedsInfo |
SubstanceAdministration.statusCode | required | ActStatusCodeActiveCompletedAbortedSuspended |
SubstanceAdministration.routeCode | required | IPSRouteOfAdmin (a valid code from http://fhir.de/CodeSystem/edqm ) |
Id | Grade | Path(s) | Details | Requirements |
entryRelationship-1 | null | SubstanceAdministration.entryRelationship:entryRelationship-1 | contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2017-04-30.html) : |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | S | 0..* | CDAR2.SubstanceAdministration | Base for all types and resources |
![]() ![]() ![]() | 1..1 | code | Binding: ActClass (required) Fixed Value: SBADM | |
![]() ![]() ![]() | 1..1 | code | Binding: MoodCodeEvnInt (required): MoodCodeEvnInt | |
![]() ![]() ![]() | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() | S | 1..1 | II | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.4 | |
![]() ![]() ![]() | S | 0..* | II | |
![]() ![]() ![]() | S | 1..1 | CD | Binding: Absent or Unknown Medication (required): Absent or Unknown Medication |
![]() ![]() ![]() | S | 0..1 | ED | |
![]() ![]() ![]() ![]() | S | 1..1 | TEL | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | ||
![]() ![]() ![]() | S | 1..1 | CS | Binding: ActStatusActiveCompletedAbortedSuspended (required): ActStatusActiveCompletedAbortedSuspended |
![]() ![]() ![]() | S | 0..1 | CE | Binding: Medicine Route of Administration (required): Medicine Route of Administration |
![]() ![]() ![]() | S | 1..1 | Element | |
![]() ![]() ![]() ![]() | 1..1 | code | Binding: ParticipationTargetDirect (required) Fixed Value: CSM | |
![]() ![]() ![]() ![]() | 1..1 | ManufacturedProduct | ||
![]() ![]() ![]() | 0..* | Author | ||
![]() ![]() ![]() | C | 0..* | Element | Slice: Unordered, Open by value:profile |
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() | 1..1 | code | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | ||
![]() ![]() ![]() ![]() | SC | 0..* | UVSubordinateadministration | Base for all types and resources entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2017-04-30.html) |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Fixed Value: COMP | |
![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | ||
![]() |
Path | Conformance | ValueSet / Code |
SubstanceAdministration.classCode | required | Fixed Value: SBADM |
SubstanceAdministration.moodCode | required | MoodCodeEvnInt |
SubstanceAdministration.code | required | IPSNoMedsInfo |
SubstanceAdministration.statusCode | required | ActStatusCodeActiveCompletedAbortedSuspended |
SubstanceAdministration.routeCode | required | IPSRouteOfAdmin (a valid code from http://fhir.de/CodeSystem/edqm ) |
SubstanceAdministration.consumable.typeCode | required | Fixed Value: CSM |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
entryRelationship-1 | null | SubstanceAdministration.entryRelationship:entryRelationship-1 | contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2017-04-30.html) : | |
subst-er-1 | error | SubstanceAdministration.entryRelationship, SubstanceAdministration.entryRelationship:entryRelationship-1 | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
Path | Conformance | ValueSet / Code |
SubstanceAdministration.classCode | required | Fixed Value: SBADM |
SubstanceAdministration.moodCode | required | MoodCodeEvnInt |
SubstanceAdministration.templateId:primary.nullFlavor | required | NullFlavor |
SubstanceAdministration.code | required | IPSNoMedsInfo |
SubstanceAdministration.text.nullFlavor | required | NullFlavor |
SubstanceAdministration.text.compression | required | CompressionAlgorithm |
SubstanceAdministration.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
SubstanceAdministration.text.reference.nullFlavor | required | NullFlavor |
SubstanceAdministration.text.reference.use | required | AddressUse |
SubstanceAdministration.statusCode | required | ActStatusCodeActiveCompletedAbortedSuspended |
SubstanceAdministration.priorityCode | extensible | ActPriority |
SubstanceAdministration.routeCode | required | IPSRouteOfAdmin (a valid code from http://fhir.de/CodeSystem/edqm ) |
SubstanceAdministration.approachSiteCode | extensible | http://terminology.hl7.org/ValueSet/v3-ActSite |
SubstanceAdministration.consumable.typeCode | required | Fixed Value: CSM |
SubstanceAdministration.subject.typeCode | required | Fixed Value: SBJ |
SubstanceAdministration.subject.contextControlCode | required | Fixed Value: OP |
SubstanceAdministration.subject.awarenessCode | extensible | TargetAwareness |
SubstanceAdministration.informant.typeCode | required | Fixed Value: INF |
SubstanceAdministration.informant.contextControlCode | required | Fixed Value: OP |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
entryRelationship-1 | null | SubstanceAdministration.entryRelationship:entryRelationship-1 | contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2017-04-30.html) : | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
subst-er-1 | error | SubstanceAdministration.entryRelationship, SubstanceAdministration.entryRelationship:entryRelationship-1 | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
This structure is derived from CDAR2.SubstanceAdministration
Summary
Mandatory: 8 elements (6 nested mandatory elements)
Must-Support: 11 elements
Fixed Value: 4 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.SubstanceAdministration
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | S | 0..* | CDAR2.SubstanceAdministration | Base for all types and resources |
![]() ![]() ![]() | 0..1 | code | ||
![]() ![]() ![]() | S | 1..1 | ||
![]() ![]() ![]() | S | 0..1 | ||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | S | 1..1 | ||
![]() ![]() ![]() ![]() | 1..1 | code | Binding: Medication Time Units (UCUM.html) (required): Medication Time Units (UCUM.html) | |
![]() ![]() ![]() | 1..1 | code | Fixed Value: SBADM | |
![]() ![]() ![]() | 1..1 | code | Binding: MoodCodeEvnInt (required): MoodCodeEvnInt | |
![]() ![]() ![]() | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() | S | 1..1 | II | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.4 | |
![]() ![]() ![]() | S | 0..* | II | |
![]() ![]() ![]() | S | 1..1 | CD | Binding: Absent or Unknown Medication (required): Absent or Unknown Medication |
![]() ![]() ![]() | S | 0..1 | ED | |
![]() ![]() ![]() ![]() | S | 1..1 | TEL | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | ||
![]() ![]() ![]() | S | 1..1 | CS | Binding: ActStatusActiveCompletedAbortedSuspended (required): ActStatusActiveCompletedAbortedSuspended |
![]() ![]() ![]() | S | 0..1 | CE | Binding: Medicine Route of Administration (required): Medicine Route of Administration |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | S | 1..1 | Element | |
![]() ![]() ![]() ![]() | 1..1 | code | Fixed Value: CSM | |
![]() ![]() ![]() | 0..* | Author | ||
![]() ![]() ![]() | 0..* | Element | Slice: Unordered, Open by value:profile | |
![]() ![]() ![]() ![]() | C | 0..* | UVSubordinateadministration | Base for all types and resources entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2017-04-30.html) |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Fixed Value: COMP | |
![]() |
Path | Conformance | ValueSet |
SubstanceAdministration.width.unit | required | MedicationTimeUnits |
SubstanceAdministration.moodCode | required | MoodCodeEvnInt |
SubstanceAdministration.code | required | IPSNoMedsInfo |
SubstanceAdministration.statusCode | required | ActStatusCodeActiveCompletedAbortedSuspended |
SubstanceAdministration.routeCode | required | IPSRouteOfAdmin (a valid code from http://fhir.de/CodeSystem/edqm ) |
Id | Grade | Path(s) | Details | Requirements |
entryRelationship-1 | null | SubstanceAdministration.entryRelationship:entryRelationship-1 | contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2017-04-30.html) : |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | S | 0..* | CDAR2.SubstanceAdministration | Base for all types and resources |
![]() ![]() ![]() | 1..1 | code | Binding: ActClass (required) Fixed Value: SBADM | |
![]() ![]() ![]() | 1..1 | code | Binding: MoodCodeEvnInt (required): MoodCodeEvnInt | |
![]() ![]() ![]() | 0..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() | S | 1..1 | II | |
![]() ![]() ![]() ![]() ![]() | 1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.4 | |
![]() ![]() ![]() | S | 0..* | II | |
![]() ![]() ![]() | S | 1..1 | CD | Binding: Absent or Unknown Medication (required): Absent or Unknown Medication |
![]() ![]() ![]() | S | 0..1 | ED | |
![]() ![]() ![]() ![]() | S | 1..1 | TEL | |
![]() ![]() ![]() ![]() ![]() | 1..1 | uri | ||
![]() ![]() ![]() | S | 1..1 | CS | Binding: ActStatusActiveCompletedAbortedSuspended (required): ActStatusActiveCompletedAbortedSuspended |
![]() ![]() ![]() | S | 0..1 | CE | Binding: Medicine Route of Administration (required): Medicine Route of Administration |
![]() ![]() ![]() | S | 1..1 | Element | |
![]() ![]() ![]() ![]() | 1..1 | code | Binding: ParticipationTargetDirect (required) Fixed Value: CSM | |
![]() ![]() ![]() ![]() | 1..1 | ManufacturedProduct | ||
![]() ![]() ![]() | 0..* | Author | ||
![]() ![]() ![]() | C | 0..* | Element | Slice: Unordered, Open by value:profile |
![]() ![]() ![]() ![]() | Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() | 1..1 | code | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | ||
![]() ![]() ![]() ![]() | SC | 0..* | UVSubordinateadministration | Base for all types and resources entryRelationship-1: contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2017-04-30.html) |
![]() ![]() ![]() ![]() ![]() | 1..1 | code | Fixed Value: COMP | |
![]() ![]() ![]() ![]() ![]() | 1..1 | boolean | ||
![]() |
Path | Conformance | ValueSet / Code |
SubstanceAdministration.classCode | required | Fixed Value: SBADM |
SubstanceAdministration.moodCode | required | MoodCodeEvnInt |
SubstanceAdministration.code | required | IPSNoMedsInfo |
SubstanceAdministration.statusCode | required | ActStatusCodeActiveCompletedAbortedSuspended |
SubstanceAdministration.routeCode | required | IPSRouteOfAdmin (a valid code from http://fhir.de/CodeSystem/edqm ) |
SubstanceAdministration.consumable.typeCode | required | Fixed Value: CSM |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
entryRelationship-1 | null | SubstanceAdministration.entryRelationship:entryRelationship-1 | contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2017-04-30.html) : | |
subst-er-1 | error | SubstanceAdministration.entryRelationship, SubstanceAdministration.entryRelationship:entryRelationship-1 | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
Snapshot View
Path | Conformance | ValueSet / Code |
SubstanceAdministration.classCode | required | Fixed Value: SBADM |
SubstanceAdministration.moodCode | required | MoodCodeEvnInt |
SubstanceAdministration.templateId:primary.nullFlavor | required | NullFlavor |
SubstanceAdministration.code | required | IPSNoMedsInfo |
SubstanceAdministration.text.nullFlavor | required | NullFlavor |
SubstanceAdministration.text.compression | required | CompressionAlgorithm |
SubstanceAdministration.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithm |
SubstanceAdministration.text.reference.nullFlavor | required | NullFlavor |
SubstanceAdministration.text.reference.use | required | AddressUse |
SubstanceAdministration.statusCode | required | ActStatusCodeActiveCompletedAbortedSuspended |
SubstanceAdministration.priorityCode | extensible | ActPriority |
SubstanceAdministration.routeCode | required | IPSRouteOfAdmin (a valid code from http://fhir.de/CodeSystem/edqm ) |
SubstanceAdministration.approachSiteCode | extensible | http://terminology.hl7.org/ValueSet/v3-ActSite |
SubstanceAdministration.consumable.typeCode | required | Fixed Value: CSM |
SubstanceAdministration.subject.typeCode | required | Fixed Value: SBJ |
SubstanceAdministration.subject.contextControlCode | required | Fixed Value: OP |
SubstanceAdministration.subject.awarenessCode | extensible | TargetAwareness |
SubstanceAdministration.informant.typeCode | required | Fixed Value: INF |
SubstanceAdministration.informant.contextControlCode | required | Fixed Value: OP |
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
entryRelationship-1 | null | SubstanceAdministration.entryRelationship:entryRelationship-1 | contains UV Subordinate Substance Administration 2.16.840.1.113883.10.21.4.6 (2017-04-30.html) : | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
subst-er-1 | error | SubstanceAdministration.entryRelationship, SubstanceAdministration.entryRelationship:entryRelationship-1 | Only one of observation, regionOfInterest, observationMedia, substanceAdministration, supply, procedure, encounter, organizer, and act : (observation | regionOfInterest | observationMedia | substanceAdministration | supply | procedure | encounter | organizer | act).count() = 1 |
This structure is derived from CDAR2.SubstanceAdministration
Summary
Mandatory: 8 elements (6 nested mandatory elements)
Must-Support: 11 elements
Fixed Value: 4 elements
Prohibited: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron