Medication Scheme Implementation Guide
1.0.0 - draft
Medication Scheme Implementation Guide, published by TEHIK. This guide is not an authorized publication; it is the continuous build for version 1.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/TEHIK-EE/ig-ee-medication-scheme/ and changes regularly. See the Directory of published versions
Official URL: https://fhir.ee/StructureDefinition/ee-tis-organization | Version: 1.0.0 | |||
Draft as of 2024-01-16 | Computable Name: EETISOrganization |
Asutus. Organization resource is used to refer to a certain identifiable place which is related to persons prescribing or dispensing medication.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from EEBaseOrganization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | EEBaseOrganization | |||
type | 0..0 | |||
alias | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past | |
description | 0..0 | |||
qualification | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | EEBaseOrganization | A grouping of people or organizations with a common purpose without substructure org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣC | 1..* | Identifier | Identifies this organization across multiple systems |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Binding: Organization Identifier Domain (required) Example General: http://www.acme.com/identifiers/patient |
value | SΣC | 1..1 | string | The value that is unique Example General: 123456 |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is in active use |
name | SΣC | 1..1 | string | Name used for the organization |
alias | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past | |
contact | C | 0..* | ExtendedContactDetail | Official contact details for the Organization org-3: The telecom of an organization can never be of use 'home' org-4: The address of an organization can never be of use 'home' |
address | S | 0..1 | EEBaseAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Organization.identifier.system | required | EEBaseOrganizationIdentifierDomainhttps://fhir.ee/ValueSet/organization-identifier-domain | |
Organization.qualification.code | example |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | 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() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-3 | error | Organization.contact | The telecom of an organization can never be of use 'home' : telecom.where(use = 'home').empty() | |
org-4 | error | Organization.contact | The address of an organization can never be of use 'home' : address.where(use = 'home').empty() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | EEBaseOrganization | A grouping of people or organizations with a common purpose without substructure org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
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: AllLanguages (required): IETF language tag for 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 | SΣC | 1..* | Identifier | Identifies this organization across multiple systems | ||||
id | 0..1 | id | 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: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Binding: Organization Identifier Domain (required) Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣC | 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) | ||||
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is in active use | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
alias | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
contact | C | 0..* | ExtendedContactDetail | Official contact details for the Organization org-3: The telecom of an organization can never be of use 'home' org-4: The address of an organization can never be of use 'home' | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
purpose | Σ | 0..1 | CodeableConcept | The type of contact Binding: Contact entity type (preferred): The purpose for which an extended contact detail should be used. | ||||
name | Σ | 0..* | HumanName | Name of an individual to contact | ||||
telecom | Σ | 0..* | ContactPoint | Contact details (e.g.phone/fax/url) | ||||
address | S | 0..1 | EEBaseAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
organization | Σ | 0..1 | Reference(Organization) | This contact detail is handled/monitored by a specific organization | ||||
period | Σ | 0..1 | Period | Period that this contact was valid for usage | ||||
partOf | Σ | 0..1 | Reference(EEBase Organization) | The organization of which this organization forms a part | ||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Organization.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Organization.identifier.system | required | EEBaseOrganizationIdentifierDomainhttps://fhir.ee/ValueSet/organization-identifier-domain | |
Organization.contact.purpose | preferred | ContactEntityTypehttp://terminology.hl7.org/ValueSet/contactentity-type | |
Organization.qualification.code | example |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | 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() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-3 | error | Organization.contact | The telecom of an organization can never be of use 'home' : telecom.where(use = 'home').empty() | |
org-4 | error | Organization.contact | The address of an organization can never be of use 'home' : address.where(use = 'home').empty() |
This structure is derived from EEBaseOrganization
Differential View
This structure is derived from EEBaseOrganization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | EEBaseOrganization | |||
type | 0..0 | |||
alias | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past | |
description | 0..0 | |||
qualification | 0..0 | |||
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | C | 0..* | EEBaseOrganization | A grouping of people or organizations with a common purpose without substructure org-1: The organization SHALL at least have a name or an identifier, and possibly more than one |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣC | 1..* | Identifier | Identifies this organization across multiple systems |
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Binding: Organization Identifier Domain (required) Example General: http://www.acme.com/identifiers/patient |
value | SΣC | 1..1 | string | The value that is unique Example General: 123456 |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is in active use |
name | SΣC | 1..1 | string | Name used for the organization |
alias | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past | |
contact | C | 0..* | ExtendedContactDetail | Official contact details for the Organization org-3: The telecom of an organization can never be of use 'home' org-4: The address of an organization can never be of use 'home' |
address | S | 0..1 | EEBaseAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Organization.identifier.system | required | EEBaseOrganizationIdentifierDomainhttps://fhir.ee/ValueSet/organization-identifier-domain | |
Organization.qualification.code | example |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | 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() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-3 | error | Organization.contact | The telecom of an organization can never be of use 'home' : telecom.where(use = 'home').empty() | |
org-4 | error | Organization.contact | The address of an organization can never be of use 'home' : address.where(use = 'home').empty() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Organization | C | 0..* | EEBaseOrganization | A grouping of people or organizations with a common purpose without substructure org-1: The organization SHALL at least have a name or an identifier, and possibly more than one | ||||
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: AllLanguages (required): IETF language tag for 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 | SΣC | 1..* | Identifier | Identifies this organization across multiple systems | ||||
id | 0..1 | id | 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: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
system | SΣ | 1..1 | uri | The namespace for the identifier value Binding: Organization Identifier Domain (required) Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣC | 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) | ||||
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is in active use | ||||
name | SΣC | 1..1 | string | Name used for the organization | ||||
alias | 0..1 | string | A list of alternate names that the organization is known as, or was known as in the past | |||||
contact | C | 0..* | ExtendedContactDetail | Official contact details for the Organization org-3: The telecom of an organization can never be of use 'home' org-4: The address of an organization can never be of use 'home' | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
purpose | Σ | 0..1 | CodeableConcept | The type of contact Binding: Contact entity type (preferred): The purpose for which an extended contact detail should be used. | ||||
name | Σ | 0..* | HumanName | Name of an individual to contact | ||||
telecom | Σ | 0..* | ContactPoint | Contact details (e.g.phone/fax/url) | ||||
address | S | 0..1 | EEBaseAddress | An address expressed using postal conventions (as opposed to GPS or other location definition formats) | ||||
organization | Σ | 0..1 | Reference(Organization) | This contact detail is handled/monitored by a specific organization | ||||
period | Σ | 0..1 | Period | Period that this contact was valid for usage | ||||
partOf | Σ | 0..1 | Reference(EEBase Organization) | The organization of which this organization forms a part | ||||
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Organization.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Organization.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|5.0.0 from the FHIR Standard | |
Organization.identifier.type | extensible | IdentifierTypeCodeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | |
Organization.identifier.system | required | EEBaseOrganizationIdentifierDomainhttps://fhir.ee/ValueSet/organization-identifier-domain | |
Organization.contact.purpose | preferred | ContactEntityTypehttp://terminology.hl7.org/ValueSet/contactentity-type | |
Organization.qualification.code | example |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Organization | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Organization | 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 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Organization | 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() | |
org-1 | error | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
org-3 | error | Organization.contact | The telecom of an organization can never be of use 'home' : telecom.where(use = 'home').empty() | |
org-4 | error | Organization.contact | The address of an organization can never be of use 'home' : address.where(use = 'home').empty() |
This structure is derived from EEBaseOrganization
Other representations of profile: CSV, Excel, Schematron