This page is part of the FHIR Specification (v0.0.82: DSTU 1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

StructureDefinition: USLabCCTarget

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/org-uslab-uslabcctarget

Copy to Organization

This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by HL7 International - Orders and Observations WG.

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This structure is derived from Organization.

Summary

Terminology Bindings

  • Organization.address.state SHALL come from Two letter USPS alphabetic codes.
  • Organization.address.country SHALL come from ISO 2 letter Country Codes (Extensible)

Required/Prohibited Elements

  • The element Organization.identifier.use is required
  • The element Organization.identifier.system is required
  • The element Organization.identifier.value is required
  • The element Organization.telecom is required
  • The element Organization.telecom.system is required
  • The element Organization.telecom.value is required
  • The element Organization.address is required
  • The element Organization.contact.name.family is required

Fixed Values

  • The element Organization.identifier.system value has been fixed to urn:oid:2.16.840.1.113883.4.6

This structure is derived from Organization.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I1..1OrganizationCopy to Organization
inv-1: Shall have Organization.name and/or Organization.identifier.
... identifier Slice: Ordered, Open, by system
... identifier S I0..*Identifier
.... use S1..1
.... system S1..1uriSee https://nppes.cms.hhs.gov/NPPES/
Fixed Value: urn:oid:2.16.840.1.113883.4.6
.... value S1..1NPI organization Identifier
... name S I0..1
... telecom S1..*
.... system S1..1
.... value S1..1
... address S1..*
.... use S0..1
.... line S0..2
.... city S0..1
.... state S0..1Binding: USPSState (required)
.... postalCode S I0..1US Zip Codes
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
.... country S0..1ISO 3166 3 letter Country Code
Binding: USCountry (extensible)
... contact S0..1Medical Director
.... name S0..1HumanName
..... family S1..1
..... given S0..2
..... prefix S0..1
..... suffix S0..1
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I1..1OrganizationCopy to Organization
org-1: The organization SHALL at least have a name or an id, and possibly more than one
inv-1: Shall have Organization.name and/or Organization.identifier.
... 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: Language (required)
... text I0..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 Σ IIdentifierIdentifies this organization across multiple systems
Slice: Ordered, Open, by system
... identifier S ΣI0..*IdentifierIdentifies this organization across multiple systems
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... label 0..1stringDescription of identifier
.... system S1..1uriSee https://nppes.cms.hhs.gov/NPPES/
Fixed Value: urn:oid:2.16.840.1.113883.4.6
.... value S1..1stringNPI organization Identifier
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... name S ΣI0..1stringName used for the organization
... type Σ0..1CodeableConceptKind of organization
Binding: OrganizationType (example)
... telecom S I1..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S I1..1codephone | fax | email | url
Binding: ContactPointSystem (required)
.... value S1..1stringThe actual contact point details
.... use ?!0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... period 0..1PeriodTime period when the contact point was/is in use
... address S I1..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... text 0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S0..2stringStreet name, number, direction & P.O. Box etc
Example: 137 Nowhere Street
.... city S0..1stringName of city, town etc.
Example: Erewhon
.... state S0..1stringSub-unit of country (abreviations ok)
Binding: USPSState (required)
.... postalCode S I0..1stringUS Zip Codes
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
.... country S0..1stringISO 3166 3 letter Country Code
Binding: USCountry (extensible)
.... period 0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1OrganizationThe organization of which this organization forms a part
... contact S0..1Medical Director
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactPartyType (required)
.... name S0..1HumanNameA name associated with the contact
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text 0..1stringText representation of the full name
..... family S1..1stringFamily name (often called 'Surname')
..... given S0..2stringGiven names (not always 'first'). Includes middle names
..... prefix S0..1stringParts that come before the name
..... suffix S0..1stringParts that come after the name
..... period 0..1PeriodTime period when name was/is in use
.... telecom 0..*ContactPointContact details (telephone, email, etc) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... active ?! Σ0..1booleanWhether the organization's record is still in active use

todo

This structure is derived from Organization.

Summary

Terminology Bindings

  • Organization.address.state SHALL come from Two letter USPS alphabetic codes.
  • Organization.address.country SHALL come from ISO 2 letter Country Codes (Extensible)

Required/Prohibited Elements

  • The element Organization.identifier.use is required
  • The element Organization.identifier.system is required
  • The element Organization.identifier.value is required
  • The element Organization.telecom is required
  • The element Organization.telecom.system is required
  • The element Organization.telecom.value is required
  • The element Organization.address is required
  • The element Organization.contact.name.family is required

Fixed Values

  • The element Organization.identifier.system value has been fixed to urn:oid:2.16.840.1.113883.4.6

Differential View

This structure is derived from Organization.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I1..1OrganizationCopy to Organization
inv-1: Shall have Organization.name and/or Organization.identifier.
... identifier Slice: Ordered, Open, by system
... identifier S I0..*Identifier
.... use S1..1
.... system S1..1uriSee https://nppes.cms.hhs.gov/NPPES/
Fixed Value: urn:oid:2.16.840.1.113883.4.6
.... value S1..1NPI organization Identifier
... name S I0..1
... telecom S1..*
.... system S1..1
.... value S1..1
... address S1..*
.... use S0..1
.... line S0..2
.... city S0..1
.... state S0..1Binding: USPSState (required)
.... postalCode S I0..1US Zip Codes
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
.... country S0..1ISO 3166 3 letter Country Code
Binding: USCountry (extensible)
... contact S0..1Medical Director
.... name S0..1HumanName
..... family S1..1
..... given S0..2
..... prefix S0..1
..... suffix S0..1

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I1..1OrganizationCopy to Organization
org-1: The organization SHALL at least have a name or an id, and possibly more than one
inv-1: Shall have Organization.name and/or Organization.identifier.
... 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: Language (required)
... text I0..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 Σ IIdentifierIdentifies this organization across multiple systems
Slice: Ordered, Open, by system
... identifier S ΣI0..*IdentifierIdentifies this organization across multiple systems
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... label 0..1stringDescription of identifier
.... system S1..1uriSee https://nppes.cms.hhs.gov/NPPES/
Fixed Value: urn:oid:2.16.840.1.113883.4.6
.... value S1..1stringNPI organization Identifier
Example: 123456
.... period 0..1PeriodTime period when id is/was valid for use
.... assigner 0..1OrganizationOrganization that issued id (may be just text)
... name S ΣI0..1stringName used for the organization
... type Σ0..1CodeableConceptKind of organization
Binding: OrganizationType (example)
... telecom S I1..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
.... extension 0..*ExtensionAdditional Content defined by implementations
.... system S I1..1codephone | fax | email | url
Binding: ContactPointSystem (required)
.... value S1..1stringThe actual contact point details
.... use ?!0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... period 0..1PeriodTime period when the contact point was/is in use
... address S I1..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
.... extension 0..*ExtensionAdditional Content defined by implementations
.... use ?! S0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... text 0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S0..2stringStreet name, number, direction & P.O. Box etc
Example: 137 Nowhere Street
.... city S0..1stringName of city, town etc.
Example: Erewhon
.... state S0..1stringSub-unit of country (abreviations ok)
Binding: USPSState (required)
.... postalCode S I0..1stringUS Zip Codes
inv-2: (Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
Example: 9132
.... country S0..1stringISO 3166 3 letter Country Code
Binding: USCountry (extensible)
.... period 0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... partOf Σ0..1OrganizationThe organization of which this organization forms a part
... contact S0..1Medical Director
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactPartyType (required)
.... name S0..1HumanNameA name associated with the contact
..... extension 0..*ExtensionAdditional Content defined by implementations
..... use ?!0..1codeusual | official | temp | nickname | anonymous | old | maiden
Binding: NameUse (required)
..... text 0..1stringText representation of the full name
..... family S1..1stringFamily name (often called 'Surname')
..... given S0..2stringGiven names (not always 'first'). Includes middle names
..... prefix S0..1stringParts that come before the name
..... suffix S0..1stringParts that come after the name
..... period 0..1PeriodTime period when name was/is in use
.... telecom 0..*ContactPointContact details (telephone, email, etc) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... active ?! Σ0..1booleanWhether the organization's record is still in active use

XML Template

JSON Template

todo

 

Other representations of profile: (todo)

Terminology Bindings

PathNameConformanceValueSet
Organization.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Organization.identifier.useIdentifierUserequiredIdentifierUse
Organization.typeOrganizationTypeexampleOrganizationType
Organization.telecom.systemContactPointSystemrequiredContactPointSystem
Organization.telecom.useContactPointUserequiredContactPointUse
Organization.address.useAddressUserequiredAddressUse
Organization.address.stateUSPSStaterequiredUSPS Two Letter Alphabetic Codes
Organization.address.countryUSCountryextensiblehttp://www.iso.org/iso/country_codes.htm
Organization.contact.purposeContactPartyTyperequiredContactEntityType
Organization.contact.name.useNameUserequiredNameUse

Constraints

IdPathNameDetails
org-1OrganizationAtLeastANameOrIdThe organization SHALL at least have a name or an id, and possibly more than one
XPath: count(f:identifier | f:name) > 0
inv-1OrganizationNameandorIDShall have Organization.name and/or Organization.identifier.
XPath: exists(f:name) or exists(f:identifier)
org-3Organization.telecomNoHomeUseTelecomThe telecom of an organization can never be of use 'home'
XPath: count(f:use[@value='home']) = 0
org-2Organization.addressNoHomeUseAddressAn address of an organization can never be of use 'home'
XPath: count(f:use[@value='home']) = 0
inv-2Organization.address.postalCodeRegex for Zip(Zip or Postal Code) SHALL be formatted as 99999[-9999] for US Zip or ZIP +4 codes or as A9A9A9 for Canadian postal codes.
XPath: f:matches(issued,[0-9]{5}(-[0-9]{4}){0,1} )
.