LinuxForHealth FHIR Implementation Guide
8.0.0 - draft
LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions
Active as of 2022-11-10 |
Definitions for the cdm-organization-affiliation resource profile.
1. OrganizationAffiliation | |
2. OrganizationAffiliation.meta | |
Type | Meta(ProcessMeta) |
3. OrganizationAffiliation.meta.profile | |
Control | 1..1 |
4. OrganizationAffiliation.contained | |
Control | 0..0* |
5. OrganizationAffiliation.extension | |
Control | 40..* |
Slicing | This element introduces a set of slices on OrganizationAffiliation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
6. OrganizationAffiliation.extension:parentHierarchyLevel | |
SliceName | parentHierarchyLevel |
Definition | Description of the level of the parent within the organinzational hierarchy |
Control | 1..1 |
Type | Extension(ParentOrganizationHierarchyLevel) (Extension Type: string) |
7. OrganizationAffiliation.extension:parentHierarchyLevelCode | |
SliceName | parentHierarchyLevelCode |
Definition | Numeric level of the practitioner within the organinzational hierarchy |
Control | 1..1 |
Type | Extension(ParentOrganizationHierarchyLevelCode) (Extension Type: integer) |
8. OrganizationAffiliation.extension:childHierarchyLevel | |
SliceName | childHierarchyLevel |
Definition | Description of the level of the child practitioner within the organinzational hierarchy |
Control | 1..1 |
Type | Extension(ChildOrganizationHierarchyLevel) (Extension Type: string) |
9. OrganizationAffiliation.extension:childHierarchyLevelCode | |
SliceName | childHierarchyLevelCode |
Definition | Numeric level of the child practitioner within the organinzational hierarchy |
Control | 1..1 |
Type | Extension(ChildOrganizationHierarchyLevelCode) (Extension Type: integer) |
10. OrganizationAffiliation.extension:hierarchyVersionId | |
SliceName | hierarchyVersionId |
Definition | Numeric version of the organinzational hierarchy represented |
Control | 0..1 |
Type | Extension(HierarchyVerionId) (Extension Type: integer) |
11. OrganizationAffiliation.extension:hierarchyVersionDate | |
SliceName | hierarchyVersionDate |
Definition | Version date of the organinzational hierarchy represented |
Control | 0..1 |
Type | Extension(HierarchyVerionDate) (Extension Type: date) |
12. OrganizationAffiliation.organization | |
Control | 10..1 |
13. OrganizationAffiliation.participatingOrganization | |
Control | 10..1 |
14. OrganizationAffiliation.telecom | |
Control | 0..0* |
15. OrganizationAffiliation.endpoint | |
Control | 0..0* |
1. OrganizationAffiliation | |
Definition | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship. |
Control | 0..* |
Invariants | Defined on this element dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty()) dom-3: 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: 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: If a resource is contained in another resource, it SHALL NOT have a security label (: contained.meta.security.empty()) dom-6: A resource should have narrative for robust management (: text.`div`.exists()) |
2. OrganizationAffiliation.meta | |
Definition | The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Meta(ProcessMeta) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
3. OrganizationAffiliation.meta.extension:ingestionBatchId | |
SliceName | ingestionBatchId |
Definition | The ID generated by an ingestion service. This represents a producer-submitted message collection |
Control | 0..1 |
Type | Extension(IngestionBatchId) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
4. OrganizationAffiliation.meta.extension:tenantId | |
SliceName | tenantId |
Definition | The ID for either the client or tenant that holds the contract with the data receiver, as recorded by the data receiver. This ID must be unique to data sent on behalf of that client or tenant within the data receiver systems. The receiver systems should associate this ID to the messages that originate from this client or tenant. This supports traceability, data protection, and data isolation, when appropriate. |
Control | 0..1 |
Type | Extension(TenantId) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
5. OrganizationAffiliation.meta.extension:processClientId | |
SliceName | processClientId |
Definition | The ID of the client as recorded in the data producer or data integrator source system(s) |
Control | 0..1 |
Type | Extension(ProcessClientId) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
6. OrganizationAffiliation.meta.extension:processOrganization | |
SliceName | processOrganization |
Definition | The organizing entity that owns the process that has produced the data held in the FHIR resource or element. Example: If an analytic service has been the producer, the process-organization value should reflect the organaization reponsible for the service. |
Control | 0..1 |
Type | Extension(ProcessOrganization) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
7. OrganizationAffiliation.meta.extension:processName | |
SliceName | processName |
Definition | The name of the process or service that has produced the data held in the FHIR resource or element. Example: If an analytic service has been the producer, use the process-name as the name of that analytic service. |
Control | 0..1 |
Type | Extension(ProcessName) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
8. OrganizationAffiliation.meta.extension:processVersion | |
SliceName | processVersion |
Definition | The version of either the process or the service that has produced the data held in the FHIR resource or element |
Control | 0..1 |
Type | Extension(ProcessVersion) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
9. OrganizationAffiliation.meta.extension:processType | |
SliceName | processType |
Definition | The classification type of the process that has produced the data held in either the FHIR resource or element |
Control | 0..1 |
Type | Extension(ProcessType) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
10. OrganizationAffiliation.meta.extension:processRecordId | |
SliceName | processRecordId |
Definition | The record ID that the data producer or data integrator uses internally to identify this data |
Control | 0..* |
Type | Extension(ProcessRecordId) (Extension Type: Identifier) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
11. OrganizationAffiliation.meta.extension:processTimestamp | |
SliceName | processTimestamp |
Definition | The timestamp when the data was generated within the FHIR resource or element |
Control | 0..1 |
Type | Extension(ProcessTimestamp) (Extension Type: dateTime) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
12. OrganizationAffiliation.meta.extension:sourceRecordId | |
SliceName | sourceRecordId |
Definition | The ID for a record that the data producer or data integrator extracted knowledge from to produce the data within the FHIR resource or element |
Control | 0..* |
Type | Extension(SourceRecordId) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
13. OrganizationAffiliation.meta.extension:sourceFileId | |
SliceName | sourceFileId |
Definition | The ID for a file from which the data producer or data integrator extracted knowledge, to produce the data within this FHIR resource or element |
Control | 0..* |
Type | Extension(SourceFileId) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
14. OrganizationAffiliation.meta.extension:sourceRecordType | |
SliceName | sourceRecordType |
Definition | Either the data model type or schema type that generates this FHIR resource |
Control | 0..1 |
Type | Extension(SourceRecordType) (Extension Type: CodeableConcept) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
15. OrganizationAffiliation.meta.extension:sourceDataModelVersion | |
SliceName | sourceDataModelVersion |
Definition | Version of the source system's data model, used by either the data producer or the data integrator |
Control | 0..1 |
Type | Extension(SourceDataModelVersion) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
16. OrganizationAffiliation.meta.extension:sourceEventTrigger | |
SliceName | sourceEventTrigger |
Definition | The event that is the catalyst for creating or updating this FHIR resource |
Control | 0..1 |
Type | Extension(SourceEventTrigger) (Extension Type: CodeableConcept) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
17. OrganizationAffiliation.meta.extension:sourceEventTrigger.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..0* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on OrganizationAffiliation.meta.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
18. OrganizationAffiliation.meta.extension:sourceEventTrigger.url | |
Definition | Source of the definition for the extension code - a logical name or a URL. |
Control | 1..1 |
Type | uri |
XML Representation | In the XML format, this property is represented as an attribute. |
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. |
Fixed Value | http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger |
19. OrganizationAffiliation.meta.extension:sourceEventTrigger.value[x] | |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Control | 0..1 |
Type | Choice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on OrganizationAffiliation.meta.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
|
20. OrganizationAffiliation.meta.extension:sourceEventTrigger.value[x]:valueCodeableConcept | |
SliceName | valueCodeableConcept |
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). |
Control | 0..1 |
Binding | For example codes, see hl7VS-eventTypeCodeFor codes, see (unbound) |
Type | Choice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
21. OrganizationAffiliation.meta.extension:sourceEventTimestamp | |
SliceName | sourceEventTimestamp |
Definition | Date and time of the source event that triggers either the creation or updating of this FHIR resource |
Control | 0..1 |
Type | Extension(SourceEventTimestamp) (Extension Type: dateTime) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
22. OrganizationAffiliation.meta.extension:insight | |
SliceName | insight |
Definition | References element level insight results pertaining to the data in this resource instance. May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Type | Extension(Insight) (Complex Extension) |
Invariants | Defined on this element ele-1: (: ) ext-1: (: ) |
23. OrganizationAffiliation.meta.profile | |
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. |
Control | 10..1* |
Type | canonical(StructureDefinition)) |
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
24. OrganizationAffiliation.meta.tag | |
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Control | 0..* |
Binding | For example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Type | Coding |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
Slicing | This element introduces a set of slices on OrganizationAffiliation.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
25. OrganizationAffiliation.meta.tag:SourceClassificationTag | |
SliceName | SourceClassificationTag |
Definition | Identifies the origin of this FHIR resource, from either a source system of record or derived from a process Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. |
Control | 0..1* |
Binding | For example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". |
Type | Coding |
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
26. OrganizationAffiliation.meta.tag:SourceClassificationTag.system | |
Definition | The identification of the code system that defines the meaning of the symbol in the code. |
Control | 10..1 |
Type | uri |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. |
Pattern Value | http://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
27. OrganizationAffiliation.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
28. OrganizationAffiliation.contained | |
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
Control | 0..0* |
Type | Resource |
Alternate Names | inline resources, anonymous resources, contained resources |
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. |
29. OrganizationAffiliation.extension | |
Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 40..* |
Type | Extension |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
Slicing | This element introduces a set of slices on OrganizationAffiliation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
30. OrganizationAffiliation.extension:parentHierarchyLevel | |
SliceName | parentHierarchyLevel |
Definition | Description of the level of the parent within the organinzational hierarchy |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ParentOrganizationHierarchyLevel) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
31. OrganizationAffiliation.extension:parentHierarchyLevelCode | |
SliceName | parentHierarchyLevelCode |
Definition | Numeric level of the practitioner within the organinzational hierarchy |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ParentOrganizationHierarchyLevelCode) (Extension Type: integer) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
32. OrganizationAffiliation.extension:childHierarchyLevel | |
SliceName | childHierarchyLevel |
Definition | Description of the level of the child practitioner within the organinzational hierarchy |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ChildOrganizationHierarchyLevel) (Extension Type: string) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
33. OrganizationAffiliation.extension:childHierarchyLevelCode | |
SliceName | childHierarchyLevelCode |
Definition | Numeric level of the child practitioner within the organinzational hierarchy |
Control | 1..1 This element is affected by the following invariants: ele-1 |
Type | Extension(ChildOrganizationHierarchyLevelCode) (Extension Type: integer) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
34. OrganizationAffiliation.extension:hierarchyVersionId | |
SliceName | hierarchyVersionId |
Definition | Numeric version of the organinzational hierarchy represented |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(HierarchyVerionId) (Extension Type: integer) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
35. OrganizationAffiliation.extension:hierarchyVersionDate | |
SliceName | hierarchyVersionDate |
Definition | Version date of the organinzational hierarchy represented |
Control | 0..1 This element is affected by the following invariants: ele-1 |
Type | Extension(HierarchyVerionDate) (Extension Type: date) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
36. OrganizationAffiliation.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Control | 0..* |
Type | Extension |
Is Modifier | true |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) |
37. OrganizationAffiliation.organization | |
Definition | Organization where the role is available (primary organization/has members). |
Control | 10..1 |
Type | Reference(Organization)) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
38. OrganizationAffiliation.participatingOrganization | |
Definition | The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of). |
Control | 10..1 |
Type | Reference(Organization)) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
39. OrganizationAffiliation.telecom | |
Definition | Contact details at the participatingOrganization relevant to this Affiliation. |
Control | 0..0* |
Type | ContactPoint |
Requirements | Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization. |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
40. OrganizationAffiliation.endpoint | |
Definition | Technical endpoints providing access to services operated for this role. |
Control | 0..0* |
Type | Reference(Endpoint)) |
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |
1. OrganizationAffiliation | |||||
Definition | Defines an affiliation/assotiation/relationship between 2 distinct oganizations, that is not a part-of relationship/sub-division relationship. | ||||
Control | 0..* | ||||
2. OrganizationAffiliation.id | |||||
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
Control | 0..1 | ||||
Type | id | ||||
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. | ||||
3. OrganizationAffiliation.meta | |||||
Definition | The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Meta(ProcessMeta) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
4. OrganizationAffiliation.meta.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
5. OrganizationAffiliation.meta.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on OrganizationAffiliation.meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
6. OrganizationAffiliation.meta.extension:ingestionBatchId | |||||
SliceName | ingestionBatchId | ||||
Definition | The ID generated by an ingestion service. This represents a producer-submitted message collection | ||||
Control | 0..1 | ||||
Type | Extension(IngestionBatchId) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
7. OrganizationAffiliation.meta.extension:tenantId | |||||
SliceName | tenantId | ||||
Definition | The ID for either the client or tenant that holds the contract with the data receiver, as recorded by the data receiver. This ID must be unique to data sent on behalf of that client or tenant within the data receiver systems. The receiver systems should associate this ID to the messages that originate from this client or tenant. This supports traceability, data protection, and data isolation, when appropriate. | ||||
Control | 0..1 | ||||
Type | Extension(TenantId) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
8. OrganizationAffiliation.meta.extension:processClientId | |||||
SliceName | processClientId | ||||
Definition | The ID of the client as recorded in the data producer or data integrator source system(s) | ||||
Control | 0..1 | ||||
Type | Extension(ProcessClientId) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
9. OrganizationAffiliation.meta.extension:processOrganization | |||||
SliceName | processOrganization | ||||
Definition | The organizing entity that owns the process that has produced the data held in the FHIR resource or element. Example: If an analytic service has been the producer, the process-organization value should reflect the organaization reponsible for the service. | ||||
Control | 0..1 | ||||
Type | Extension(ProcessOrganization) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
10. OrganizationAffiliation.meta.extension:processName | |||||
SliceName | processName | ||||
Definition | The name of the process or service that has produced the data held in the FHIR resource or element. Example: If an analytic service has been the producer, use the process-name as the name of that analytic service. | ||||
Control | 0..1 | ||||
Type | Extension(ProcessName) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
11. OrganizationAffiliation.meta.extension:processVersion | |||||
SliceName | processVersion | ||||
Definition | The version of either the process or the service that has produced the data held in the FHIR resource or element | ||||
Control | 0..1 | ||||
Type | Extension(ProcessVersion) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
12. OrganizationAffiliation.meta.extension:processType | |||||
SliceName | processType | ||||
Definition | The classification type of the process that has produced the data held in either the FHIR resource or element | ||||
Control | 0..1 | ||||
Type | Extension(ProcessType) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
13. OrganizationAffiliation.meta.extension:processRecordId | |||||
SliceName | processRecordId | ||||
Definition | The record ID that the data producer or data integrator uses internally to identify this data | ||||
Control | 0..* | ||||
Type | Extension(ProcessRecordId) (Extension Type: Identifier) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
14. OrganizationAffiliation.meta.extension:processTimestamp | |||||
SliceName | processTimestamp | ||||
Definition | The timestamp when the data was generated within the FHIR resource or element | ||||
Control | 0..1 | ||||
Type | Extension(ProcessTimestamp) (Extension Type: dateTime) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
15. OrganizationAffiliation.meta.extension:sourceRecordId | |||||
SliceName | sourceRecordId | ||||
Definition | The ID for a record that the data producer or data integrator extracted knowledge from to produce the data within the FHIR resource or element | ||||
Control | 0..* | ||||
Type | Extension(SourceRecordId) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
16. OrganizationAffiliation.meta.extension:sourceFileId | |||||
SliceName | sourceFileId | ||||
Definition | The ID for a file from which the data producer or data integrator extracted knowledge, to produce the data within this FHIR resource or element | ||||
Control | 0..* | ||||
Type | Extension(SourceFileId) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
17. OrganizationAffiliation.meta.extension:sourceRecordType | |||||
SliceName | sourceRecordType | ||||
Definition | Either the data model type or schema type that generates this FHIR resource | ||||
Control | 0..1 | ||||
Type | Extension(SourceRecordType) (Extension Type: CodeableConcept) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
18. OrganizationAffiliation.meta.extension:sourceDataModelVersion | |||||
SliceName | sourceDataModelVersion | ||||
Definition | Version of the source system's data model, used by either the data producer or the data integrator | ||||
Control | 0..1 | ||||
Type | Extension(SourceDataModelVersion) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
19. OrganizationAffiliation.meta.extension:sourceEventTrigger | |||||
SliceName | sourceEventTrigger | ||||
Definition | The event that is the catalyst for creating or updating this FHIR resource | ||||
Control | 0..1 | ||||
Type | Extension(SourceEventTrigger) (Extension Type: CodeableConcept) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
20. OrganizationAffiliation.meta.extension:sourceEventTrigger.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
21. OrganizationAffiliation.meta.extension:sourceEventTrigger.extension | |||||
Definition | An Extension | ||||
Control | 0..0 | ||||
Type | Extension | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on OrganizationAffiliation.meta.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
22. OrganizationAffiliation.meta.extension:sourceEventTrigger.url | |||||
Definition | Source of the definition for the extension code - a logical name or a URL. | ||||
Control | 1..1 | ||||
Type | uri | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
Comments | The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. | ||||
Fixed Value | http://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger | ||||
23. OrganizationAffiliation.meta.extension:sourceEventTrigger.value[x] | |||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Control | 0..1 | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on OrganizationAffiliation.meta.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
| ||||
24. OrganizationAffiliation.meta.extension:sourceEventTrigger.value[x]:valueCodeableConcept | |||||
SliceName | valueCodeableConcept | ||||
Definition | Value of extension - must be one of a constrained set of the data types (see Extensibility for a list). | ||||
Control | 0..1 | ||||
Binding | For example codes, see hl7VS-eventTypeCode | ||||
Type | CodeableConcept | ||||
[x] Note | See Choice of Data Types for further information about how to use [x] | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
25. OrganizationAffiliation.meta.extension:sourceEventTimestamp | |||||
SliceName | sourceEventTimestamp | ||||
Definition | Date and time of the source event that triggers either the creation or updating of this FHIR resource | ||||
Control | 0..1 | ||||
Type | Extension(SourceEventTimestamp) (Extension Type: dateTime) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
26. OrganizationAffiliation.meta.extension:insight | |||||
SliceName | insight | ||||
Definition | References element level insight results pertaining to the data in this resource instance. | ||||
Control | 0..* | ||||
Type | Extension(Insight) (Complex Extension) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
27. OrganizationAffiliation.meta.versionId | |||||
Definition | The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted. | ||||
Control | 0..1 | ||||
Type | id | ||||
Comments | The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
28. OrganizationAffiliation.meta.lastUpdated | |||||
Definition | When the resource last changed - e.g. when the version changed. | ||||
Control | 0..1 | ||||
Type | instant | ||||
Comments | This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
29. OrganizationAffiliation.meta.source | |||||
Definition | A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Comments | In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used. This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
30. OrganizationAffiliation.meta.profile | |||||
Definition | A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url. | ||||
Control | 1..1 | ||||
Type | canonical(StructureDefinition)) | ||||
Comments | It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
31. OrganizationAffiliation.meta.security | |||||
Definition | Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure. | ||||
Control | 0..* | ||||
Binding | The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System | ||||
Type | Coding | ||||
Comments | The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
32. OrganizationAffiliation.meta.tag | |||||
Definition | Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource. | ||||
Control | 0..* | ||||
Binding | For example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
Type | Coding | ||||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
Slicing | This element introduces a set of slices on OrganizationAffiliation.meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
33. OrganizationAffiliation.meta.tag:SourceClassificationTag | |||||
SliceName | SourceClassificationTag | ||||
Definition | Identifies the origin of this FHIR resource, from either a source system of record or derived from a process | ||||
Control | 0..1 | ||||
Binding | For example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones" | ||||
Type | Coding | ||||
Comments | The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
34. OrganizationAffiliation.meta.tag:SourceClassificationTag.id | |||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
Control | 0..1 | ||||
Type | string | ||||
XML Representation | In the XML format, this property is represented as an attribute. | ||||
35. OrganizationAffiliation.meta.tag:SourceClassificationTag.extension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||
Control | 0..* | ||||
Type | Extension | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on OrganizationAffiliation.meta.tag.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
36. OrganizationAffiliation.meta.tag:SourceClassificationTag.system | |||||
Definition | The identification of the code system that defines the meaning of the symbol in the code. | ||||
Control | 1..1 | ||||
Type | uri | ||||
Requirements | Need to be unambiguous about the source of the definition of the symbol. | ||||
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously. | ||||
Pattern Value | http://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
37. OrganizationAffiliation.meta.tag:SourceClassificationTag.version | |||||
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. | ||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||
Control | 0..1 | ||||
Type | string | ||||
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
38. OrganizationAffiliation.meta.tag:SourceClassificationTag.code | |||||
Definition | A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination). | ||||
Control | 0..1 | ||||
Binding | The codes SHALL be taken from Source Classification Value Set | ||||
Type | code | ||||
Requirements | Need to refer to a particular code in the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
39. OrganizationAffiliation.meta.tag:SourceClassificationTag.display | |||||
Definition | A representation of the meaning of the code in the system, following the rules of the system. | ||||
Control | 0..1 | ||||
Type | string | ||||
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
40. OrganizationAffiliation.meta.tag:SourceClassificationTag.userSelected | |||||
Definition | Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays). | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Requirements | This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing. | ||||
Comments | Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
41. OrganizationAffiliation.implicitRules | |||||
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc. | ||||
Control | 0..1 | ||||
Type | uri | ||||
Is Modifier | true | ||||
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
42. OrganizationAffiliation.language | |||||
Definition | The base language in which the resource is written. | ||||
Control | 0..1 | ||||
Binding | The codes SHOULD be taken from CommonLanguages
A human language
| ||||
Type | code | ||||
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
43. OrganizationAffiliation.text | |||||
Definition | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. | ||||
Control | 0..1 | ||||
Type | Narrative | ||||
Alternate Names | narrativehtmlxhtmldisplay | ||||
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
44. OrganizationAffiliation.contained | |||||
Definition | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. | ||||
Control | 0..0 | ||||
Type | Resource | ||||
Alternate Names | inline resourcesanonymous resourcescontained resources | ||||
Comments | This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels. | ||||
45. OrganizationAffiliation.extension | |||||
Definition | An Extension | ||||
Control | 4..* | ||||
Type | Extension | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
Slicing | This element introduces a set of slices on OrganizationAffiliation.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
| ||||
46. OrganizationAffiliation.extension:parentHierarchyLevel | |||||
SliceName | parentHierarchyLevel | ||||
Definition | Description of the level of the parent within the organinzational hierarchy | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ParentOrganizationHierarchyLevel) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
47. OrganizationAffiliation.extension:parentHierarchyLevelCode | |||||
SliceName | parentHierarchyLevelCode | ||||
Definition | Numeric level of the practitioner within the organinzational hierarchy | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ParentOrganizationHierarchyLevelCode) (Extension Type: integer) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
48. OrganizationAffiliation.extension:childHierarchyLevel | |||||
SliceName | childHierarchyLevel | ||||
Definition | Description of the level of the child practitioner within the organinzational hierarchy | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ChildOrganizationHierarchyLevel) (Extension Type: string) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
49. OrganizationAffiliation.extension:childHierarchyLevelCode | |||||
SliceName | childHierarchyLevelCode | ||||
Definition | Numeric level of the child practitioner within the organinzational hierarchy | ||||
Control | 1..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(ChildOrganizationHierarchyLevelCode) (Extension Type: integer) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
50. OrganizationAffiliation.extension:hierarchyVersionId | |||||
SliceName | hierarchyVersionId | ||||
Definition | Numeric version of the organinzational hierarchy represented | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(HierarchyVerionId) (Extension Type: integer) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
51. OrganizationAffiliation.extension:hierarchyVersionDate | |||||
SliceName | hierarchyVersionDate | ||||
Definition | Version date of the organinzational hierarchy represented | ||||
Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
Type | Extension(HierarchyVerionDate) (Extension Type: date) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
52. OrganizationAffiliation.modifierExtension | |||||
Definition | May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | ||||
Control | 0..* | ||||
Type | Extension | ||||
Is Modifier | true | ||||
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. | ||||
Alternate Names | extensionsuser content | ||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists()) | ||||
53. OrganizationAffiliation.identifier | |||||
Definition | Business identifiers that are specific to this role. | ||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||
Control | 0..* | ||||
Type | Identifier | ||||
Requirements | Often, specific identities are assigned for the agent. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
54. OrganizationAffiliation.active | |||||
Definition | Whether this organization affiliation record is in active use. | ||||
Control | 0..1 | ||||
Type | boolean | ||||
Requirements | Need to be able to mark an organization affiliation record as not to be used because it was created in error, or otherwise no longer in active use. | ||||
Comments | If this value is false, you may refer to the period to see when the role was in active use. If there is no period specified, no inference can be made about when it was active. | ||||
Meaning if Missing | This resource is generally assumed to be active if no value is provided for the active element | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
55. OrganizationAffiliation.period | |||||
Definition | The period during which the participatingOrganization is affiliated with the primary organization. | ||||
Control | 0..1 | ||||
Type | Period | ||||
Requirements | An affiliation may be created ahead of time and only be active for a defined period of time. Once the affiliation is complete, the fact that it existed may still be required. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
56. OrganizationAffiliation.organization | |||||
Definition | Organization where the role is available (primary organization/has members). | ||||
Control | 1..1 | ||||
Type | Reference(Organization)) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
57. OrganizationAffiliation.participatingOrganization | |||||
Definition | The Participating Organization provides/performs the role(s) defined by the code to the Primary Organization (e.g. providing services or is a member of). | ||||
Control | 1..1 | ||||
Type | Reference(Organization)) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
58. OrganizationAffiliation.network | |||||
Definition | Health insurance provider network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined). | ||||
Control | 0..* | ||||
Type | Reference(Organization)) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
59. OrganizationAffiliation.code | |||||
Definition | Definition of the role the participatingOrganization plays in the association. | ||||
Control | 0..* | ||||
Binding | For example codes, see OrganizationAffiliationRole The role the participating organization providing services to the primary organization | ||||
Type | CodeableConcept | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
60. OrganizationAffiliation.specialty | |||||
Definition | Specific specialty of the participatingOrganization in the context of the role. | ||||
Control | 0..* | ||||
Binding | The codes SHOULD be taken from PracticeSettingCodeValueSet Specific specialty associated with the participating organization | ||||
Type | CodeableConcept | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
61. OrganizationAffiliation.location | |||||
Definition | The location(s) at which the role occurs. | ||||
Control | 0..* | ||||
Type | Reference(Location)) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
62. OrganizationAffiliation.healthcareService | |||||
Definition | Healthcare services provided through the role. | ||||
Control | 0..* | ||||
Type | Reference(HealthcareService)) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
63. OrganizationAffiliation.telecom | |||||
Definition | Contact details at the participatingOrganization relevant to this Affiliation. | ||||
Control | 0..0 | ||||
Type | ContactPoint | ||||
Requirements | Sometimes a participating organization provides dedicated contacts to handle enquiries specifically for the role provided to the affiliated organization. | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) | ||||
64. OrganizationAffiliation.endpoint | |||||
Definition | Technical endpoints providing access to services operated for this role. | ||||
Control | 0..0 | ||||
Type | Reference(Endpoint)) | ||||
Invariants | Defined on this element ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count())) |