SPL Mapping FHIR R5 Implementation Guide
0.2.1 - Build CI
SPL Mapping FHIR R5 Implementation Guide
0.2.1 - Build CI
SPL Mapping FHIR R5 Implementation Guide, published by HL7 International / Biomedical Research and Regulation. This guide is not an authorized publication; it is the continuous build for version 0.2.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-spl/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/spl/StructureDefinition/USAgentAffiliation | Version: 0.2.1 | |||
| Standards status: Trial-use | Maturity Level: 1 | Computable Name: USAgentAffiliation | ||
A profile that associates an organization to its US Agent.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from OrganizationAffiliation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  OrganizationAffiliation |
OrganizationAffiliation | |||
  organization |
S | 1..1 | Reference(LabelerOrganization | EstablishmentOrganization) | Organization where the role is available |
| participatingOrganization |
S | 1..1 | Reference(USAgentOrganization) | Organization that provides/performs the role (e.g. providing services or is a member of) |
  code |
S | 1..1 | CodeableConcept | Definition of the role the participatingOrganization plays Required Pattern: At least the following |
  coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
 code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: C73330 | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OrganizationAffiliation |
0..* | OrganizationAffiliation | Defines an affiliation/association/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
 implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| organization |
SΣ | 1..1 | Reference(LabelerOrganization | EstablishmentOrganization) | Organization where the role is available ele-1: All FHIR elements must have a @value or children |
| participatingOrganization |
SΣ | 1..1 | Reference(USAgentOrganization) | Organization that provides/performs the role (e.g. providing services or is a member of) ele-1: All FHIR elements must have a @value or children |
 code |
SΣ | 1..1 | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: C73330 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| OrganizationAffiliation.code | example | Pattern: C73330http://hl7.org/fhir/ValueSet/organization-rolefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | OrganizationAffiliation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | OrganizationAffiliation | 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 | OrganizationAffiliation | 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 | OrganizationAffiliation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | OrganizationAffiliation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| OrganizationAffiliation |
0..* | OrganizationAffiliation | Defines an affiliation/association/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship | |||||
| 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 |
Σ | 0..* | Identifier | Business identifiers that are specific to this role | ||||
| active |
Σ | 0..1 | boolean | Whether this organization affiliation record is in active use | ||||
| period |
Σ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | ||||
| organization |
SΣ | 1..1 | Reference(LabelerOrganization | EstablishmentOrganization) | Organization where the role is available | ||||
| participatingOrganization |
SΣ | 1..1 | Reference(USAgentOrganization) | Organization that provides/performs the role (e.g. providing services or is a member of) | ||||
| network |
Σ | 0..* | Reference(Organization) | The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) | ||||
 code |
SΣ | 1..1 | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization. Required Pattern: At least the following | ||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: C73330 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| specialty |
Σ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the participating organization. | ||||
| location |
Σ | 0..* | Reference(Location) | The location(s) at which the role occurs | ||||
| healthcareService |
0..* | Reference(HealthcareService) | Healthcare services provided through the role | |||||
| contact |
C | 0..* | ExtendedContactDetail | Official contact details at the participatingOrganization relevant to this Affiliation 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' | ||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for this role | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| OrganizationAffiliation.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| OrganizationAffiliation.code | example | Pattern: C73330http://hl7.org/fhir/ValueSet/organization-rolefrom the FHIR Standard | |
| OrganizationAffiliation.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | OrganizationAffiliation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | OrganizationAffiliation | 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 | OrganizationAffiliation | 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 | OrganizationAffiliation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | OrganizationAffiliation | 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-3 | error | OrganizationAffiliation.contact | The telecom of an organization can never be of use 'home' : telecom.where(use = 'home').empty() | |
| org-4 | error | OrganizationAffiliation.contact | The address of an organization can never be of use 'home' : address.where(use = 'home').empty() |
This structure is derived from OrganizationAffiliation
Summary
Mandatory: 3 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Maturity: 1
Differential View
This structure is derived from OrganizationAffiliation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OrganizationAffiliation |
OrganizationAffiliation | |||
| organization |
S | 1..1 | Reference(LabelerOrganization | EstablishmentOrganization) | Organization where the role is available |
| participatingOrganization |
S | 1..1 | Reference(USAgentOrganization) | Organization that provides/performs the role (e.g. providing services or is a member of) |
| code |
S | 1..1 | CodeableConcept | Definition of the role the participatingOrganization plays Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: C73330 | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| OrganizationAffiliation |
0..* | OrganizationAffiliation | Defines an affiliation/association/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both |
| organization |
SΣ | 1..1 | Reference(LabelerOrganization | EstablishmentOrganization) | Organization where the role is available ele-1: All FHIR elements must have a @value or children |
| participatingOrganization |
SΣ | 1..1 | Reference(USAgentOrganization) | Organization that provides/performs the role (e.g. providing services or is a member of) ele-1: All FHIR elements must have a @value or children |
| code |
SΣ | 1..1 | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization. ele-1: All FHIR elements must have a @value or children Required Pattern: At least the following |
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: C73330 | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| OrganizationAffiliation.code | example | Pattern: C73330http://hl7.org/fhir/ValueSet/organization-rolefrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | OrganizationAffiliation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | OrganizationAffiliation | 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 | OrganizationAffiliation | 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 | OrganizationAffiliation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | OrganizationAffiliation | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| OrganizationAffiliation |
0..* | OrganizationAffiliation | Defines an affiliation/association/relationship between 2 distinct organizations, that is not a part-of relationship/sub-division relationship | |||||
| 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 |
Σ | 0..* | Identifier | Business identifiers that are specific to this role | ||||
| active |
Σ | 0..1 | boolean | Whether this organization affiliation record is in active use | ||||
| period |
Σ | 0..1 | Period | The period during which the participatingOrganization is affiliated with the primary organization | ||||
| organization |
SΣ | 1..1 | Reference(LabelerOrganization | EstablishmentOrganization) | Organization where the role is available | ||||
| participatingOrganization |
SΣ | 1..1 | Reference(USAgentOrganization) | Organization that provides/performs the role (e.g. providing services or is a member of) | ||||
| network |
Σ | 0..* | Reference(Organization) | The network in which the participatingOrganization provides the role's services (if defined) at the indicated locations (if defined) | ||||
| code |
SΣ | 1..1 | CodeableConcept | Definition of the role the participatingOrganization plays Binding: OrganizationAffiliationRole (example): The role the participating organization providing services to the primary organization. Required Pattern: At least the following | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| coding |
1..* | Coding | Code defined by a terminology system Fixed Value: (complex) | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| system |
1..1 | uri | Identity of the terminology system Fixed Value: http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl | |||||
| version |
0..1 | string | Version of the system - if relevant | |||||
| code |
1..1 | code | Symbol in syntax defined by the system Fixed Value: C73330 | |||||
| display |
0..1 | string | Representation defined by the system | |||||
| userSelected |
0..1 | boolean | If this coding was chosen directly by the user | |||||
| text |
0..1 | string | Plain text representation of the concept | |||||
| specialty |
Σ | 0..* | CodeableConcept | Specific specialty of the participatingOrganization in the context of the role Binding: PracticeSettingCodeValueSet (preferred): Specific specialty associated with the participating organization. | ||||
| location |
Σ | 0..* | Reference(Location) | The location(s) at which the role occurs | ||||
| healthcareService |
0..* | Reference(HealthcareService) | Healthcare services provided through the role | |||||
| contact |
C | 0..* | ExtendedContactDetail | Official contact details at the participatingOrganization relevant to this Affiliation 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' | ||||
| endpoint |
0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for this role | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI |
| OrganizationAffiliation.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0from the FHIR Standard | |
| OrganizationAffiliation.code | example | Pattern: C73330http://hl7.org/fhir/ValueSet/organization-rolefrom the FHIR Standard | |
| OrganizationAffiliation.specialty | preferred | PracticeSettingCodeValueSethttp://hl7.org/fhir/ValueSet/c80-practice-codesfrom the FHIR Standard |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | OrganizationAffiliation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | OrganizationAffiliation | 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 | OrganizationAffiliation | 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 | OrganizationAffiliation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | OrganizationAffiliation | 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-3 | error | OrganizationAffiliation.contact | The telecom of an organization can never be of use 'home' : telecom.where(use = 'home').empty() | |
| org-4 | error | OrganizationAffiliation.contact | The address of an organization can never be of use 'home' : address.where(use = 'home').empty() |
This structure is derived from OrganizationAffiliation
Summary
Mandatory: 3 elements
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Biomedical Research and Regulation. Package hl7.fhir.us.spl#0.2.1 based on FHIR 5.0.0. Generated 2024-12-10
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change