This page is part of the electronic Case Reporting (eCR) (v1.1.0: STU 2 on FHIR R4 Ballot 1) based on FHIR R4. The current version which supercedes this version is 2.1.0. For a full list of available versions, see the Directory of published versions
Defining URL: | http://hl7.org/fhir/us/ecr/StructureDefinition/rr-routing-entity-organization |
Version: | 1.1.0 |
Name: | RR_Routing_Entity_Organization |
Title: | Routing Entity Organization |
Status: | Active as of 2020-12-16T19:27:50+00:00 |
Definition: | This Organization profile represents the Routing Entity which is a PHA or other organization identified by the PHA (such as an HIE) to which the eICR and/or the Reportability Response will be provided immediately following the creation of the Reportability Response. |
Publisher: | HL7 Public Health Work Group (http://www.hl7.org/Special/committees/pher/index.cfm) |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/ecr/StructureDefinition/rr-routing-entity-organization
This entity may just be acting to route the eICR and Reportability Response on their way to a Responsible Agency. It is based on the eCR Organization profile with a further restriction setting the type data element to ‘Routing Entity’.
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from USPublicHealthOrganization
This structure is derived from USPublicHealthOrganization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | S | 1..* | USPublicHealthOrganization | Routing Entity |
text | S | 0..1 | Narrative | Routing Entity Description |
identifier | S | 0..* | Identifier | Routing Entity Id |
type | S | 1..1 | CodeableConcept | Kind of organization 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: urn:oid:2.16.840.1.114222.4.5.232 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RR7 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Routing Entity | |
name | S | 1..1 | string | Routing Entity Name |
telecom | S | 0..* | ContactPoint | Routing Entity Contact Information |
address | S | 0..* | Address | Routing Entity Address |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | SI | 1..* | USPublicHealthOrganization | Routing Entity |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | S | 0..1 | Narrative | Routing Entity Description |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣI | 0..* | (Slice Definition) | Routing Entity Id Slice: Unordered, Open by pattern:$this |
identifier:NPI | SΣI | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |
type | 0..1 | CodeableConcept | Description of identifier | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
value | 0..1 | string | The value that is unique | |
period | 0..1 | Period | Time period when id is/was valid for use | |
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
identifier:CLIA | SΣI | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |
type | 0..1 | CodeableConcept | Description of identifier | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |
value | 0..1 | string | The value that is unique | |
period | 0..1 | Period | Time period when id is/was valid for use | |
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
type | SΣ | 1..1 | CodeableConcept | Kind of organization Binding: ServiceDeliveryLocationRoleType (extensible): The type of 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: urn:oid:2.16.840.1.114222.4.5.232 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RR7 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Routing Entity | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
name | SΣI | 1..1 | string | Routing Entity Name |
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
telecom | SI | 0..* | ContactPoint | Routing Entity Contact Information |
address | SI | 0..* | Address | Routing Entity Address |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
line | SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
district | Σ | 0..1 | string | District name (aka county) Example General: Madison |
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"} |
partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part |
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |
name | 0..1 | HumanName | A name associated with the contact | |
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
address | 0..1 | Address | Visiting or postal addresses for the contact | |
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | I | 1..* | USPublicHealthOrganization | Routing Entity |
text | 0..1 | Narrative | Routing Entity Description | |
identifier | ΣI | 0..* | (Slice Definition) | Routing Entity Id Slice: Unordered, Open by pattern:$this |
identifier:NPI | ΣI | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
identifier:CLIA | ΣI | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |
active | ?!Σ | 1..1 | boolean | Whether the organization's record is still in active use |
type | Σ | 1..1 | CodeableConcept | Kind of organization Binding: ServiceDeliveryLocationRoleType (extensible): The type of Organization 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: urn:oid:2.16.840.1.114222.4.5.232 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RR7 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Routing Entity | |
name | ΣI | 1..1 | string | Routing Entity Name |
telecom | I | 0..* | ContactPoint | Routing Entity Contact Information |
address | I | 0..* | Address | Routing Entity Address |
line | Σ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label |
city | Σ | 0..1 | string | Name of city, town etc. |
state | Σ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
postalCode | Σ | 0..1 | string | US Zip Codes |
country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
contact | 0..* | BackboneElement | Contact for the organization for a certain purpose | |
Documentation for this format |
This structure is derived from USPublicHealthOrganization
Differential View
This structure is derived from USPublicHealthOrganization
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | S | 1..* | USPublicHealthOrganization | Routing Entity |
text | S | 0..1 | Narrative | Routing Entity Description |
identifier | S | 0..* | Identifier | Routing Entity Id |
type | S | 1..1 | CodeableConcept | Kind of organization 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: urn:oid:2.16.840.1.114222.4.5.232 | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RR7 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Routing Entity | |
name | S | 1..1 | string | Routing Entity Name |
telecom | S | 0..* | ContactPoint | Routing Entity Contact Information |
address | S | 0..* | Address | Routing Entity Address |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | SI | 1..* | USPublicHealthOrganization | Routing Entity |
id | Σ | 0..1 | string | Logical id of this artifact |
meta | Σ | 0..1 | Meta | Metadata about the resource |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages: A human language. | |
text | S | 0..1 | Narrative | Routing Entity Description |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣI | 0..* | (Slice Definition) | Routing Entity Id Slice: Unordered, Open by pattern:$this |
identifier:NPI | SΣI | 0..1 | Identifier | National Provider Identifier (NPI) Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |
type | 0..1 | CodeableConcept | Description of identifier | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: http://hl7.org/fhir/sid/us-npi | |
value | 0..1 | string | The value that is unique | |
period | 0..1 | Period | Time period when id is/was valid for use | |
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
identifier:CLIA | SΣI | 0..1 | Identifier | Clinical Laboratory Improvement Amendments (CLIA) Number for laboratories Required Pattern: At least the following |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
use | 0..1 | code | usual | official | temp | secondary | old (If known) | |
type | 0..1 | CodeableConcept | Description of identifier | |
system | 1..1 | uri | The namespace for the identifier value Fixed Value: urn:oid:2.16.840.1.113883.4.7 | |
value | 0..1 | string | The value that is unique | |
period | 0..1 | Period | Time period when id is/was valid for use | |
assigner | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
type | SΣ | 1..1 | CodeableConcept | Kind of organization Binding: ServiceDeliveryLocationRoleType (extensible): The type of 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: urn:oid:2.16.840.1.114222.4.5.232 | |
version | 0..1 | string | Version of the system - if relevant | |
code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: RR7 | |
display | 1..1 | string | Representation defined by the system Fixed Value: Routing Entity | |
userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
text | 0..1 | string | Plain text representation of the concept | |
name | SΣI | 1..1 | string | Routing Entity Name |
alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
telecom | SI | 0..* | ContactPoint | Routing Entity Contact Information |
address | SI | 0..* | Address | Routing Entity Address |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
use | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home |
type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both |
text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 |
line | SΣ | 0..4 | string | Street name, number, direction & P.O. Box etc. This repeating element order: The order in which lines should appear in an address label Example General: 137 Nowhere Street |
city | SΣ | 0..1 | string | Name of city, town etc. Example General: Erewhon |
district | Σ | 0..1 | string | District name (aka county) Example General: Madison |
state | SΣ | 0..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two letter USPS alphabetic codes. |
postalCode | SΣ | 0..1 | string | US Zip Codes Example General: 9132 |
country | SΣ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) |
period | Σ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"} |
partOf | Σ | 0..1 | Reference(Organization) | The organization of which this organization forms a part |
contact | S | 0..* | BackboneElement | Contact for the organization for a certain purpose |
id | 0..1 | string | Unique id for inter-element referencing | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible): The purpose for which you would contact a contact party. | |
name | 0..1 | HumanName | A name associated with the contact | |
telecom | 0..* | ContactPoint | Contact details (telephone, email, etc.) for a contact | |
address | 0..1 | Address | Visiting or postal addresses for the contact | |
endpoint | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization | |
Documentation for this format |
Other representations of profile: Schematron
Path | Conformance | ValueSet / Code |
Organization.language | preferred | CommonLanguages Max Binding: AllLanguages |
Organization.type | extensible | Pattern: RR7("Routing Entity") |
Organization.address.use | required | AddressUse |
Organization.address.type | required | AddressType |
Organization.address.state | extensible | UspsTwoLetterAlphabeticCodes |
Organization.contact.purpose | extensible | ContactEntityType |
Id | Path | Details | Requirements |
dom-2 | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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 | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | Organization | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Organization | A resource should have narrative for robust management : text.`div`.exists() | |
org-1 | Organization | The organization SHALL at least have a name or an identifier, and possibly more than one : (identifier.count() + name.count()) > 0 | |
ele-1 | Organization.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Organization.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Organization.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Organization.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Organization.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.identifier:NPI | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.identifier:CLIA | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.active | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.alias | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
org-3 | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
ele-1 | Organization.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
org-2 | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
ele-1 | Organization.address.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Organization.address.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Organization.address.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.address.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.address.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.address.line | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.address.city | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.address.district | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.address.state | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.address.postalCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.address.country | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.address.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.contact | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.contact.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Organization.contact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Organization.contact.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Organization.contact.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Organization.contact.purpose | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.contact.name | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.contact.telecom | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.contact.address | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Organization.endpoint | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |