abstractbaseDefinitioncopyrightdatedescriptionexperimentalfhirVersionjurisdiction
jurisdiction[0]kindnamepublisherpurposestatustitletypeurlversion| Left: | Specialty Rx Patient (http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-patient) |
| Right: | Specialty Rx Patient (http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-patient) |
| Name | Value | Comments | |
|---|---|---|---|
| abstract | false | ||
| baseDefinition | http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient | ||
| copyright | |||
| date | 2020-03-20 | ||
| description | This profile tailors the Patient resource for carrying the patient information needed to support specialty medication dispensing and enrollment in related programs. | ||
| experimental | false | ||
| fhirVersion | 4.0.1 | ||
| jurisdiction | |||
| jurisdiction[0] | urn:iso:std:iso:3166#US | ||
| kind | resource | ||
| name | SpecialtyRxPatient | ||
| publisher | HL7 International - Pharmacy | ||
| purpose | |||
| status | active | ||
| title | Specialty Rx Patient | ||
| type | Patient | ||
| url | http://hl7.org/fhir/us/specialty-rx/StructureDefinition/specialty-rx-patient | ||
| version | 2.0.0-ballot | ||
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | L Type | L Description & Constraints | Comments | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
 Patient | 0..* | Information about an individual or animal receiving health care services | 0..* | USCorePatientProfile | Information about an individual or animal receiving health care services | ||||||||||||
 id | Σ | 0..1 | string | Logical id of this artifact | Σ | 0..1 | string | Logical id of this artifact | |||||||||
 meta | SΣ | 0..1 | Meta | Metadata about the resource | SΣ | 0..1 | Meta | Metadata about the resource | |||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
 Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| versionId | Σ | 0..1 | id | Version specific identifier | Σ | 0..1 | id | Version specific identifier | |||||||||
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed | Σ | 0..1 | instant | When the resource version last changed | |||||||||
| source | SΣ | 0..1 | uri | Identifies where the resource comes from | SΣ | 0..1 | uri | Identifies where the resource comes from | |||||||||
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | |||||||||
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: todo (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | |||||||||
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: todo (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | |||||||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
| language | 0..1 | code | Language of the resource content Binding: todo (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||||||||
| contained | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
| Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||||||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
| identifier | SΣ | 1..* | Identifier | An identifier for this patient | SΣ | 1..* | Identifier | An identifier for this patient | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 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: todo (required): Identifies the purpose for this identifier, if known . | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | |||||||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: todo (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | |||||||||
| system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | |||||||||
| value | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | SΣ | 1..1 | string | The value that is unique within the system. Example General: 123456 | |||||||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | Σ | 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) | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | |||||||||
| active | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | ?!Σ | 0..1 | boolean | Whether this patient's record is in active use | |||||||||
| name | SΣI | 1..* | HumanName | A name associated with the patient | SΣI | 1..* | HumanName | A name associated with the patient | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| use | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: todo (required): The use of a human name. | ?!Σ | 0..1 | code | usual | official | temp | nickname | anonymous | old | maiden Binding: NameUse (required): The use of a human name. | |||||||||
| text | Σ | 0..1 | string | Text representation of the full name | Σ | 0..1 | string | Text representation of the full name | |||||||||
| family | SΣI | 1..1 | string | Family name (often called 'Surname') | SΣI | 1..1 | string | Family name (often called 'Surname') | |||||||||
| given | SΣI | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | SΣI | 1..* | string | Given names (not always 'first'). Includes middle names This repeating element order: Given Names appear in the correct order for presenting the name | |||||||||
| prefix | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | Σ | 0..* | string | Parts that come before the name This repeating element order: Prefixes appear in the correct order for presenting the name | |||||||||
| suffix | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | Σ | 0..* | string | Parts that come after the name This repeating element order: Suffixes appear in the correct order for presenting the name | |||||||||
| period | Σ | 0..1 | Period | Time period when name was/is in use | Σ | 0..1 | Period | Time period when name was/is in use | |||||||||
| telecom | SΣ | 1..* | ContactPoint | A contact detail for the individual | SΣ | 1..* | ContactPoint | A contact detail for the individual | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||||||||
| system | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: todo (required): Telecommunications form for contact point. | SΣI | 1..1 | code | phone | fax | email | pager | url | sms | other Binding: ContactPointSystem (required): Telecommunications form for contact point. | |||||||||
| value | SΣ | 1..1 | string | The actual contact point details | SΣ | 1..1 | string | The actual contact point details | |||||||||
| use | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: todo (required) | ?!SΣ | 0..1 | code | home | work | temp | old | mobile - purpose of this contact point Binding: ContactPointUse (required) | |||||||||
| rank | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | Σ | 0..1 | positiveInt | Specify preferred order of use (1 = highest) | |||||||||
| period | Σ | 0..1 | Period | Time period when the contact point was/is in use | Σ | 0..1 | Period | Time period when the contact point was/is in use | |||||||||
| gender | SΣ | 1..1 | code | male | female | other | unknown Binding: todo (required) | SΣ | 1..1 | code | male | female | other | unknown Binding: AdministrativeGender (required) | |||||||||
| birthDate | SΣ | 1..1 | date | The date of birth for the individual | SΣ | 1..1 | date | The date of birth for the individual | |||||||||
| deceased[x] | ?!Σ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not | ?!Σ | 0..1 | boolean, dateTime | Indicates if the individual is deceased or not | |||||||||
| address | SΣ | 1..1 | Address | An address for the individual | SΣ | 1..1 | Address | An address for the individual | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | 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: todo (required): The use of an address. Example General: home | ?!Σ | 0..1 | code | home | work | temp | old | billing - purpose of this address Binding: AddressUse (required): The use of an address. Example General: home | |||||||||
| type | Σ | 0..1 | code | postal | physical | both Binding: todo (required): The type of an address (physical / postal). Example General: both | Σ | 0..1 | code | postal | physical | both Binding: AddressType (required): The type of an address (physical / postal). Example General: both | |||||||||
| text | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | Σ | 0..1 | string | Text representation of the address Example General: 137 Nowhere Street, Erewhon 9132 | |||||||||
| line | SΣ | 1..* | 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 | SΣ | 1..* | 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Σ | 1..1 | string | Name of city, town etc. Example General: Erewhon | SΣ | 1..1 | string | Name of city, town etc. Example General: Erewhon | |||||||||
| district | Σ | 0..1 | string | District name (aka county) Example General: Madison | Σ | 0..1 | string | District name (aka county) Example General: Madison | |||||||||
| state | SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: todo (extensible): Two Letter USPS alphabetic codes. | SΣ | 1..1 | string | Sub-unit of country (abbreviations ok) Binding: USPS Two Letter Alphabetic Codes (extensible): Two Letter USPS alphabetic codes. | |||||||||
| postalCode | SΣ | 1..1 | string | US Zip Codes Example General: 9132 | SΣ | 1..1 | string | US Zip Codes Example General: 9132 | |||||||||
| country | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | Σ | 0..1 | string | Country (e.g. can be ISO 3166 2 or 3 letter code) | |||||||||
| period | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"} | SΣ | 0..1 | Period | Time period when address was/is in use Example General: {"start":"2010-03-23T00:00:00+11:00","end":"2010-07-01T00:00:00+10:00"} | |||||||||
| maritalStatus | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: todo (extensible): The domestic partnership status of a person. | 0..1 | CodeableConcept | Marital (civil) status of a patient Binding: Marital Status Codes (extensible): The domestic partnership status of a person. | |||||||||||
| multipleBirth[x] | 0..1 | boolean, integer | Whether patient is part of a multiple birth | 0..1 | boolean, integer | Whether patient is part of a multiple birth | |||||||||||
| photo | 0..* | Attachment | Image of the patient | 0..* | Attachment | Image of the patient | |||||||||||
| contact | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | I | 0..* | BackboneElement | A contact party (e.g. guardian, partner, friend) for the patient | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| relationship | 0..* | CodeableConcept | The kind of relationship Binding: todo (extensible): The nature of the relationship between a patient and a contact person for that patient. | 0..* | CodeableConcept | The kind of relationship Binding: PatientContactRelationship (extensible): The nature of the relationship between a patient and a contact person for that patient. | |||||||||||
| name | 0..1 | HumanName | A name associated with the contact person | 0..1 | HumanName | A name associated with the contact person | |||||||||||
| telecom | 0..* | ContactPoint | A contact detail for the person | 0..* | ContactPoint | A contact detail for the person | |||||||||||
| address | 0..1 | Address | Address for the contact person | 0..1 | Address | Address for the contact person | |||||||||||
| gender | 0..1 | code | male | female | other | unknown Binding: todo (required): The gender of a person used for administrative purposes. | 0..1 | code | male | female | other | unknown Binding: AdministrativeGender (required): The gender of a person used for administrative purposes. | |||||||||||
| organization | I | 0..1 | Reference(Organization) | Organization that is associated with the contact | I | 0..1 | Reference(Organization) | Organization that is associated with the contact | |||||||||
| period | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | 0..1 | Period | The period during which this contact person or organization is valid to be contacted relating to this patient | |||||||||||
| communication | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | S | 0..* | BackboneElement | A language which may be used to communicate with the patient about his or her health | |||||||||
| id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| language | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: todo (extensible) | S | 1..1 | CodeableConcept | The language which can be used to communicate with the patient about his or her health Binding: Language codes with language and optionally a region modifier (extensible) | |||||||||
| preferred | 0..1 | boolean | Language preference indicator | 0..1 | boolean | Language preference indicator | |||||||||||
| generalPractitioner | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | 0..* | Reference(Organization | Practitioner | PractitionerRole) | Patient's nominated primary care provider | |||||||||||
| managingOrganization | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | Σ | 0..1 | Reference(Organization) | Organization that is the custodian of the patient record | |||||||||
 link | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | ?!Σ | 0..* | BackboneElement | Link to another patient resource that concerns the same actual person | |||||||||
 id | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
| extension | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
| other | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | Σ | 1..1 | Reference(Patient | RelatedPerson) | The other patient or related person resource that the link refers to | |||||||||
| type | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: todo (required): The type of link between this patient resource and another patient resource. | Σ | 1..1 | code | replaced-by | replaces | refer | seealso Binding: LinkType (required): The type of link between this patient resource and another patient resource. | |||||||||
| Documentation for this format | |||||||||||||||||