This page is part of the Da Vinci Health Record Exchange (v0.1.0: STU 1 Ballot 1) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions
SD.5 StructureDefinition-hrex-organization
title: StructureDefinition-hrex-organization-intro layout: default active: StructureDefinition-hrex-organization-intro —
Requires support of either an NPI or TIN identifier.
SD.5.1 Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/us/davinci-hrex/StructureDefinition/hrex-organization
Published on Thu Jun 20 08:10:27 EDT 2019 as a draft by .
This profile builds on USCoreOrganizationProfile
Summary
Mandatory: 0 element (2 nested mandatory elements)
Must-Support: 5 elements
Slices
This structure defines the following Slices:
- The element Organization.identifier is sliced based on the value of value:system
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | 0..* | |||
identifier | S | Identifier | Slice: Unordered, Open by value:system | |
identifier | S | 0..1 | Identifier | Required Pattern: {"system":"http://hl7.org/fhir/sid/us-npi"} |
type | S | 1..1 | CodeableConcept | Required Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"PRN"}]} |
identifier | S | 0..1 | Identifier | Required Pattern: {"system":"urn:oid:2.16.840.1.113883.4.4"} |
type | S | 1..1 | CodeableConcept | Required Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"TAX"}]} |
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Organization | I | 0..* | A grouping of people or organizations with a common purpose | |
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: CommonLanguages (preferred) Max Binding: AllLanguages | |
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
contained | 0..* | Resource | Contained, inline Resources | |
extension | 0..* | Extension | Additional content defined by implementations | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣI | Identifier | Identifies this organization across multiple systems Slice: Unordered, Open by value:system | |
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 | usual | official | temp | secondary | old (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 |
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 | 0..1 | Identifier | Identifies this organization across multiple systems Required Pattern: {"system":"http://hl7.org/fhir/sid/us-npi"} |
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 | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Required Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"PRN"}]} |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient |
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 | 0..1 | Identifier | Identifies this organization across multiple systems Required Pattern: {"system":"urn:oid:2.16.840.1.113883.4.4"} |
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 | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
type | SΣ | 1..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) Required Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"TAX"}]} |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General': http://www.acme.com/identifiers/patient |
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) |
active | ?!SΣ | 1..1 | boolean | Whether the organization's record is still in active use |
type | Σ | 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 | 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) 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..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) |
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-04:00","end":"2010-07-01T00:00:00-04:00"} |
partOf | Σ | 0..1 | Reference(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 | 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) | |
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