Da Vinci Health Record Exchange (HRex) Implementation Guide Release 0.1.0

Da Vinci Health Record Exchange (HRex) - CI build (v0.1.0). 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 09:39:48 UTC 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

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*
... identifier SIdentifierSlice: Unordered, Open by value:system
... identifier S0..1IdentifierRequired Pattern: {"system":"http://hl7.org/fhir/sid/us-npi"}
.... type S1..1CodeableConceptRequired Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"PRN"}]}
... identifier S0..1IdentifierRequired Pattern: {"system":"urn:oid:2.16.840.1.113883.4.4"}
.... type S1..1CodeableConceptRequired Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"TAX"}]}

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A grouping of people or organizations with a common purpose
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier SΣIIdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system SΣ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier SΣI0..1IdentifierIdentifies this organization across multiple systems

Required Pattern: {"system":"http://hl7.org/fhir/sid/us-npi"}
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
Required Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"PRN"}]}
.... system SΣ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... identifier SΣI0..1IdentifierIdentifies this organization across multiple systems

Required Pattern: {"system":"urn:oid:2.16.840.1.113883.4.4"}
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codeusual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required)
.... type SΣ1..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
Required Pattern: {"coding":[{"system":"http://terminology.hl7.org/CodeSystem/v2-0203","code":"TAX"}]}
.... system SΣ1..1uriThe namespace for the identifier value
Example General': http://www.acme.com/identifiers/patient
.... value Σ0..1stringThe value that is unique
Example General': 123456
.... period Σ0..1PeriodTime period when id is/was valid for use
.... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name SΣI1..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom SI1..*ContactPointA contact detail for the organization
... address SI1..*AddressAn address for the organization
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... use ?!Σ0..1codehome | work | temp | old | billing - purpose of this address
Binding: AddressUse (required)
Example General': home
.... type Σ0..1codepostal | physical | both
Binding: AddressType (required)
Example General': both
.... text Σ0..1stringText representation of the address
Example General': 137 Nowhere Street, Erewhon 9132
.... line SΣ0..4stringStreet 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..1stringName of city, town etc.
Example General': Erewhon
.... district Σ0..1stringDistrict name (aka county)
Example General': Madison
.... state SΣ0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (extensible)
.... postalCode SΣ0..1stringUS Zip Codes
Example General': 9132
.... country SΣ0..1stringCountry (e.g. can be ISO 3166 2 or 3 letter code)
.... period Σ0..1PeriodTime period when address was/is in use
Example General': {"start":"2010-03-23T04:00:00+00:00","end":"2010-07-01T04:00:00+00:00"}
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint S0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron