DSTU2

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

A.10.3.0 StructureDefinition: USLab-CCTarget

The official URL for this profile is: 

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

Copy to Organization

This profile was published on Mon, Nov 17, 2014 00:00+1100 as a draft by Health Level Seven International (Orders and Observations - US Lab).

A.10.3.0.1 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

Mandatory: 4 elements (+4 nested mandatory elements)
Must-Support: 21 elements
Fixed Value: 1 element

Slices

This structure defines the following Slices:

  • The element Organization.identifier is sliced based on the value of system (ordered)

This structure is derived from Organization.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationCopy to Organization
inv-1: Shall have Organization.name and/or Organization.identifier.
... identifier S IIdentifierSlice: Ordered, Open, by system
.... use S1..1code
.... system S1..1uriSee http://hl7.org/fhir/sid/us-npi
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... value S1..1stringNPI organization Identifier
... name S I0..1string
... telecom S1..*ContactPoint
.... system S1..1code
.... value S1..1string
... address S1..*Address
.... use S0..1code
.... line S0..2string
.... city S0..1string
.... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (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.
.... country S0..1stringISO 3166 3 letter Country Code
Binding: ISO Country Codes (required)
... contact S0..1BackboneElementMedical Director
.... name S0..1HumanName
..... family S1..1string
..... given S0..2string
..... prefix S0..1string
..... suffix S0..1string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationCopy 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: IETF BCP-47 (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 ?! S∑1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriSee http://hl7.org/fhir/sid/us-npi
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... value S ∑1..1stringNPI organization Identifier
Example: 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 ?! ∑0..1booleanWhether the organization's record is still in active use
... type ∑0..1CodeableConceptKind of organization
Binding: OrganizationType (example)
... name S ∑I0..1stringName used for the organization
... 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 | pager | other
Binding: ContactPointSystem (required)
.... value S ∑1..1stringThe actual contact point details
.... use ?! ∑0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
.... 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 ?! S∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S ∑0..2stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city S ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state S ∑0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (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 S ∑0..1stringISO 3166 3 letter Country Code
Binding: ISO Country Codes (required)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... partOf ∑0..1Reference(Organization)The organization of which this organization forms a part
... contact S0..1BackboneElementMedical Director
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... 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 S ∑1..1stringFamily name (often called 'Surname')
..... given S ∑0..2stringGiven names (not always 'first'). Includes middle names
..... prefix S ∑0..1stringParts that come before the name
..... suffix S ∑0..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

doco Documentation for this format

todo

This structure is derived from Organization.

Summary

Mandatory: 4 elements (+4 nested mandatory elements)
Must-Support: 21 elements
Fixed Value: 1 element

Slices

This structure defines the following Slices:

  • The element Organization.identifier is sliced based on the value of system (ordered)

Differential View

This structure is derived from Organization.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationCopy to Organization
inv-1: Shall have Organization.name and/or Organization.identifier.
... identifier S IIdentifierSlice: Ordered, Open, by system
.... use S1..1code
.... system S1..1uriSee http://hl7.org/fhir/sid/us-npi
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... value S1..1stringNPI organization Identifier
... name S I0..1string
... telecom S1..*ContactPoint
.... system S1..1code
.... value S1..1string
... address S1..*Address
.... use S0..1code
.... line S0..2string
.... city S0..1string
.... state S0..1stringBinding: USPS Two Letter Alphabetic Codes (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.
.... country S0..1stringISO 3166 3 letter Country Code
Binding: ISO Country Codes (required)
... contact S0..1BackboneElementMedical Director
.... name S0..1HumanName
..... family S1..1string
..... given S0..2string
..... prefix S0..1string
..... suffix S0..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*OrganizationCopy 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: IETF BCP-47 (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 ?! S∑1..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
.... type ∑0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
.... system S ∑1..1uriSee http://hl7.org/fhir/sid/us-npi
Fixed Value: http://hl7.org/fhir/sid/us-npi
.... value S ∑1..1stringNPI organization Identifier
Example: 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 ?! ∑0..1booleanWhether the organization's record is still in active use
... type ∑0..1CodeableConceptKind of organization
Binding: OrganizationType (example)
... name S ∑I0..1stringName used for the organization
... 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 | pager | other
Binding: ContactPointSystem (required)
.... value S ∑1..1stringThe actual contact point details
.... use ?! ∑0..1codehome | work | temp | old | mobile - purpose of this contact point
Binding: ContactPointUse (required)
.... rank ∑0..1positiveIntSpecify preferred order of use (1 = highest)
.... 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 ?! S∑0..1codehome | work | temp | old - purpose of this address
Binding: AddressUse (required)
Example: home
.... type ∑0..1codepostal | physical | both
Binding: AddressType (required)
Example: both
.... text ∑0..1stringText representation of the address
Example: 137 Nowhere Street, Erewhon 9132
.... line S ∑0..2stringStreet name, number, direction & P.O. Box etc.
Example: 137 Nowhere Street
.... city S ∑0..1stringName of city, town etc.
Example: Erewhon
.... district ∑0..1stringDistrict name (aka county)
Example: Madison
.... state S ∑0..1stringSub-unit of country (abbreviations ok)
Binding: USPS Two Letter Alphabetic Codes (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 S ∑0..1stringISO 3166 3 letter Country Code
Binding: ISO Country Codes (required)
.... period ∑0..1PeriodTime period when address was/is in use
Example: {"start":"2010-03-23","end":"2010-07-01"}
... partOf ∑0..1Reference(Organization)The organization of which this organization forms a part
... contact S0..1BackboneElementMedical Director
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... 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 S ∑1..1stringFamily name (often called 'Surname')
..... given S ∑0..2stringGiven names (not always 'first'). Includes middle names
..... prefix S ∑0..1stringParts that come before the name
..... suffix S ∑0..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

doco Documentation for this format

XML Template

JSON Template

todo

 

Other representations of profile: Schematron

A.10.3.0.2 Terminology Bindings

PathNameConformanceValueSet
Organization.language?extrequiredhttp://tools.ietf.org/html/bcp47
Organization.identifier.useIdentifierUserequiredIdentifierUse
Organization.identifier.typeIdentifier Type CodesextensibleIdentifier Type Codes
Organization.typeOrganizationTypeexampleOrganizationType
Organization.telecom.systemContactPointSystemrequiredContactPointSystem
Organization.telecom.useContactPointUserequiredContactPointUse
Organization.address.useAddressUserequiredAddressUse
Organization.address.typeAddressTyperequiredAddressType
Organization.address.stateUSPS Two Letter Alphabetic CodesrequiredUSPS Two Letter Alphabetic Codes
Organization.address.country?extrequiredhttp://www.iso.org/iso/country_codes.htm
Organization.contact.purposeContactEntityTypeextensibleContactEntityType
Organization.contact.name.useNameUserequiredNameUse

A.10.3.0.3 Constraints

IdPathDetailsRequirements
org-1OrganizationThe organization SHALL at least have a name or an id, and possibly more than one
XPath: count(f:identifier | f:name) > 0
inv-1OrganizationShall have Organization.name and/or Organization.identifier.
XPath: exists(f:name) or exists(f:identifier)
org-3Organization.telecomThe telecom of an organization can never be of use 'home'
XPath: count(f:use[@value='home']) = 0
org-2Organization.addressAn address of an organization can never be of use 'home'
XPath: count(f:use[@value='home']) = 0
inv-2Organization.address.postalCode(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} )
.