This page is part of the Da Vinci Data Exchange for Quality Measures (DEQM) FHIR IG (v0.1.0: STU 1 Ballot 1) based on FHIR R3. The current version which supercedes this version is 3.1.0. For a full list of available versions, see the Directory of published versions 
StructureDefinition-organization-deqm
source file: source/pages/_includes/organization-deqm-intro.md
The DEQM Organization Profile defines the constraints for representing the organization for which the practitioner was working when he performed the measure to which he is attesting.
Mandatory Data Elements and Terminology
The following data-elements are mandatory (i.e data MUST be present).
Each Organization must have:
- Either an NPI or EIN (TIN) identifier
Additional Profile specific implementation guidance:
None
Examples
Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/us/davinci-deqm/STU3/StructureDefinition/organization-deqm
Published on Tue Jun 19 00:00:00 AEST 2018 as a active by Da Vinci Project.
This profile builds on QICore-Organization
Summary
Mandatory: 4 elements
Must-Support: 7 elements
Fixed Value: 2 elements
Slices
This structure defines the following Slices:
- The element Organization.identifier is sliced based on the value of value:system
- The element Organization.identifier.system is sliced based on the value of value:@this
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization | 0..* | |||
  identifier | SI | Identifier | Slice: Unordered, Open by value:system dv-1: If present, `Identifier.type` SHALL be 'PRN' when `Identifier.system` = 'http://hl7.org/fhir/sid/us-npi' and 'TAX' when `Identifier.system` = 'http://hl7.org/fhir/us/davinci-deqm/STU3/sid/us-tin'. | |
 identifier | S | 1..1 | Identifier | |
   type | S | 0..1 | CodeableConcept | Binding: DEQM Organization Type Value Set (required) |
| system | S | uri | Slice: Unordered, Open by value:@this | |
 system | S | 1..1 | uri | National Provider Identifier (NPI) Fixed Value: http://hl7.org/fhir/sid/us-npi |
| system | S | 1..1 | uri | U.S. IRS Assigned Employer Identification Number EIN (TIN) Fixed Value: urn:oid:2.16.840.1.113883.4.4 |
 value | S | 0..1 | string | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | US Core Organization Profile | |
| 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: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣI | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system dv-1: If present, `Identifier.type` SHALL be 'PRN' when `Identifier.system` = 'http://hl7.org/fhir/sid/us-npi' and 'TAX' when `Identifier.system` = 'http://hl7.org/fhir/us/davinci-deqm/STU3/sid/us-tin'. | |
  id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
| value | Σ | 0..1 | string | The value that is unique Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
  assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | SΣI | 1..1 | Identifier | Identifies this organization across multiple systems |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: DEQM Organization Type Value Set (required) |
| system | SΣ | uri | The namespace for the identifier value Slice: Unordered, Open by value:@this Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri | |
| system | SΣ | 1..1 | uri | National Provider Identifier (NPI) Fixed Value: http://hl7.org/fhir/sid/us-npi |
| system | SΣ | 1..1 | uri | U.S. IRS Assigned Employer Identification Number EIN (TIN) Fixed Value: urn:oid:2.16.840.1.113883.4.4 |
| value | SΣ | 0..1 | string | The value that is unique Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
| type | SΣ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example) |
| name | SΣI | 1..1 | string | Name used for the organization |
| alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
| telecom | SI | 1..* | ContactPoint | A contact detail for the organization |
| address | SI | 1..* | Address | An address for the organization |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example General': home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both |
| text | Σ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132 |
| line | SΣ | 0..* | 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 (required) |
| postalCode | SΣ | 0..1 | string | US Zip Codes Example General': 9132 |
| country | Σ | 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-22T23:00:00+10:00","end":"2010-07-01T00:00:00+10:00"} |
| partOf | Σ | 0..1 | Reference(QICore-Organization) | The organization of which this organization forms a part |
| contact | I | 0..* | BackboneElement | Contact for the organization for a certain purpose |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
| 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 | S | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization |
| Documentation for this format | ||||
Summary
Mandatory: 4 elements
Must-Support: 7 elements
Fixed Value: 2 elements
Slices
This structure defines the following Slices:
- The element Organization.identifier is sliced based on the value of value:system
- The element Organization.identifier.system is sliced based on the value of value:@this
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | 0..* | |||
| identifier | SI | Identifier | Slice: Unordered, Open by value:system dv-1: If present, `Identifier.type` SHALL be 'PRN' when `Identifier.system` = 'http://hl7.org/fhir/sid/us-npi' and 'TAX' when `Identifier.system` = 'http://hl7.org/fhir/us/davinci-deqm/STU3/sid/us-tin'. | |
| identifier | S | 1..1 | Identifier | |
| type | S | 0..1 | CodeableConcept | Binding: DEQM Organization Type Value Set (required) |
| system | S | uri | Slice: Unordered, Open by value:@this | |
| system | S | 1..1 | uri | National Provider Identifier (NPI) Fixed Value: http://hl7.org/fhir/sid/us-npi |
| system | S | 1..1 | uri | U.S. IRS Assigned Employer Identification Number EIN (TIN) Fixed Value: urn:oid:2.16.840.1.113883.4.4 |
| value | S | 0..1 | string | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | US Core Organization Profile | |
| 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: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣI | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system dv-1: If present, `Identifier.type` SHALL be 'PRN' when `Identifier.system` = 'http://hl7.org/fhir/sid/us-npi' and 'TAX' when `Identifier.system` = 'http://hl7.org/fhir/us/davinci-deqm/STU3/sid/us-tin'. | |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri |
| value | Σ | 0..1 | string | The value that is unique Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| identifier | SΣI | 1..1 | Identifier | Identifies this organization across multiple systems |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary (If known) Binding: IdentifierUse (required) |
| type | SΣ | 0..1 | CodeableConcept | Description of identifier Binding: DEQM Organization Type Value Set (required) |
| system | SΣ | uri | The namespace for the identifier value Slice: Unordered, Open by value:@this Example General': http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri | |
| system | SΣ | 1..1 | uri | National Provider Identifier (NPI) Fixed Value: http://hl7.org/fhir/sid/us-npi |
| system | SΣ | 1..1 | uri | U.S. IRS Assigned Employer Identification Number EIN (TIN) Fixed Value: urn:oid:2.16.840.1.113883.4.4 |
| value | SΣ | 0..1 | string | The value that is unique Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
| type | SΣ | 0..* | CodeableConcept | Kind of organization Binding: OrganizationType (example) |
| name | SΣI | 1..1 | string | Name used for the organization |
| alias | 0..* | string | A list of alternate names that the organization is known as, or was known as in the past | |
| telecom | SI | 1..* | ContactPoint | A contact detail for the organization |
| address | SI | 1..* | Address | An address for the organization |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | home | work | temp | old - purpose of this address Binding: AddressUse (required) Example General': home |
| type | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required) Example General': both |
| text | Σ | 0..1 | string | Text representation of the address Example General': 137 Nowhere Street, Erewhon 9132 |
| line | SΣ | 0..* | 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 (required) |
| postalCode | SΣ | 0..1 | string | US Zip Codes Example General': 9132 |
| country | Σ | 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-22T23:00:00+10:00","end":"2010-07-01T00:00:00+10:00"} |
| partOf | Σ | 0..1 | Reference(QICore-Organization) | The organization of which this organization forms a part |
| contact | I | 0..* | BackboneElement | Contact for the organization for a certain purpose |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| purpose | 0..1 | CodeableConcept | The type of contact Binding: ContactEntityType (extensible) | |
| 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 | S | 0..* | Reference(Endpoint) | Technical endpoints providing access to services operated for the organization |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Quick Start
Below is an overview of the required set of RESTful FHIR interactions - for example, search and read operations - for this profile. See the Conformance requirements for a complete list of supported RESTful interactions for this IG.
source file: source/pages/_includes/organization-deqm-search.md
Use cases:
