Current Build
The official URL for this profile is:
http://hl7.org/fhir/fpar/StructureDefinition/fpar-organization
This profile builds on http://hl7.org/fhir/fpar/StructureDefintion/hspc-organization.
This profile was published on Thu May 04 00:00:00 EDT 2017 as a draft by Healthcare Services Platform Consortium on behalf of Family Planning Annual Report.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from
This structure is derived from
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Organization | FPAR Organization Profile | |||
  organizationPeriod | 0..1 | Period | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/organizationPeriod | |
 type | 0..1 | CodeableConcept | Binding: HSPC Organization Type (preferred) | |
| identifier | S | 1..* | Identifier | |
   system | S | 1..1 | uri | |
| active | S | 1..1 | boolean | |
| name | S | 1..1 | string | |
| telecom | S | 1..* | ContactPoint | |
| address | S | 1..* | Address | |
 line | S | 0..* | string | |
| city | S | 0..1 | string | |
| state | S | 0..1 | string | Binding: USPS Two Letter Alphabetic Codes (required) |
| postalCode | S | 0..1 | string | US Zip Codes |
| contact | ||||
| contactPeriod | 0..1 | Period | Contact Period URL: http://hl7.org/fhir/fpar/StructureDefinition/contactPeriod | |
| primaryLanguage | 0..1 | CodeableConcept | Primary Language URL: http://hl7.org/fhir/fpar/StructureDefinition/primaryLanguage | |
  endpoint | S | 0..* | Reference(Endpoint) | |
| Documentation for this format | ||||
This structure is derived from
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | FPAR Organization | |
| 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 | |
| organizationPeriod | I | 0..* | Period | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/organizationPeriod ext-1: Must have either extensions or value[x], not both |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣI | 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 | Σ | 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) |
| 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 | 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-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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| contactPeriod | I | 0..1 | Period | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/contactPeriod ext-1: Must have either extensions or value[x], not both |
| primaryLanguage | I | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/primaryLanguage ext-1: Must have either extensions or value[x], not both |
| 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 | ||||
This structure is derived from
Differential View
This structure is derived from
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | FPAR Organization Profile | |||
| organizationPeriod | 0..1 | Period | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/organizationPeriod | |
| type | 0..1 | CodeableConcept | Binding: HSPC Organization Type (preferred) | |
| identifier | S | 1..* | Identifier | |
| system | S | 1..1 | uri | |
| active | S | 1..1 | boolean | |
| name | S | 1..1 | string | |
| telecom | S | 1..* | ContactPoint | |
| address | S | 1..* | Address | |
| line | S | 0..* | string | |
| city | S | 0..1 | string | |
| state | S | 0..1 | string | Binding: USPS Two Letter Alphabetic Codes (required) |
| postalCode | S | 0..1 | string | US Zip Codes |
| contact | ||||
| contactPeriod | 0..1 | Period | Contact Period URL: http://hl7.org/fhir/fpar/StructureDefinition/contactPeriod | |
| primaryLanguage | 0..1 | CodeableConcept | Primary Language URL: http://hl7.org/fhir/fpar/StructureDefinition/primaryLanguage | |
| endpoint | S | 0..* | Reference(Endpoint) | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Organization | I | 0..* | FPAR Organization | |
| 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 | |
| organizationPeriod | I | 0..* | Period | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/organizationPeriod ext-1: Must have either extensions or value[x], not both |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | SΣI | 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 | Σ | 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) |
| 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 | 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-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 | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations Slice: Unordered, Open by value:url | |
| contactPeriod | I | 0..1 | Period | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/contactPeriod ext-1: Must have either extensions or value[x], not both |
| primaryLanguage | I | 0..1 | CodeableConcept | Extension URL: http://hl7.org/fhir/fpar/StructureDefinition/primaryLanguage ext-1: Must have either extensions or value[x], not both |
| 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 | ||||
| Path | Name | Conformance | ValueSet |
| Organization.language | Common Languages | extensible | Common Languages |
| Organization.identifier.use | IdentifierUse | required | IdentifierUse |
| Organization.identifier.type | Identifier Type Codes | extensible | Identifier Type Codes |
| Organization.type | OrganizationType | example | OrganizationType |
| Organization.address.use | AddressUse | required | AddressUse |
| Organization.address.type | AddressType | required | AddressType |
| Organization.address.state | USPS Two Letter Alphabetic Codes | required | USPS Two Letter Alphabetic Codes |
| Organization.contact.purpose | ContactEntityType | extensible | ContactEntityType |
| Id | Path | Details | Requirements |
| dom-2 | Organization | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Organization | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | Organization | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-3 | Organization | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| org-1 | Organization | The organization SHALL at least have a name or an id, and possibly more than one : (identifier.count() + name.count()) > 0 | |
| ext-1 | Organization.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| org-3 | Organization.telecom | The telecom of an organization can never be of use 'home' : where(use = 'home').empty() | |
| org-2 | Organization.address | An address of an organization can never be of use 'home' : where(use = 'home').empty() | |
| ele-1 | Organization.contact | All FHIR elements must have a @value or children : children().count() > id.count() | |
| ext-1 | Organization.contact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ext-1 | Organization.contact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ext-1 | Organization.contact.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
© HL7.org 2011+. FHIR STU3 Candidate (v3.0.1-11917) generated on
Fri, Feb 15, 2019 12:55-0500. QA Page
Links: Search 
| Version History | Table of Contents
| 
| Propose a change